{
  "openapi": "3.0.1",
  "info": {
    "title": "ClasificadosOnline Scraper - Puerto Rico Property Listings",
    "description": "Scrape ClasificadosOnline Bienes Raíces, Puerto Rico's biggest classifieds site: homes, apartments, land and rentals with USD price, bedrooms, baths, town, neighbourhood, brokerage and photos. Filter by town, type, price, pets, parking and Section 8.",
    "version": "1.0",
    "x-build-id": "dfzLbkNFZQhYC21Pb"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/sian.agency~clasificadosonline-property-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-sian.agency-clasificadosonline-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/sian.agency~clasificadosonline-property-scraper/runs": {
      "post": {
        "operationId": "runs-sync-sian.agency-clasificadosonline-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/sian.agency~clasificadosonline-property-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-sian.agency-clasificadosonline-property-scraper",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "operation": {
            "title": "🎯 Mode",
            "enum": [
              "search",
              "detail"
            ],
            "type": "string",
            "description": "Property Search reads ClasificadosOnline results pages. Property Detail opens the advert addresses you paste in the Advert URLs field.",
            "default": "search"
          },
          "dealType": {
            "title": "🏷️ Sale or rent",
            "enum": [
              "sale",
              "rent"
            ],
            "type": "string",
            "description": "Which side of the market to read. For rentals every price is the monthly rent in US dollars.",
            "default": "sale"
          },
          "propertyType": {
            "title": "🏠 Property type",
            "enum": [
              "any",
              "apartment",
              "walkup",
              "house",
              "multifamily",
              "commercial",
              "farm",
              "land",
              "land-or-farm",
              "room"
            ],
            "type": "string",
            "description": "Which kind of property. Some types exist on only one side of the market: commercial, multi-family, farms and lots are for sale; rooms and land-or-farm are for rent. A type that does not exist for the side you picked stops the run before anything is charged.",
            "default": "any"
          },
          "municipality": {
            "title": "📍 Where",
            "enum": [
              "all-puerto-rico",
              "region-metro",
              "region-central",
              "region-norte",
              "region-sur",
              "region-este",
              "region-oeste",
              "adjuntas",
              "aguada",
              "aguadilla",
              "aguas-buenas",
              "aibonito",
              "anasco",
              "arecibo",
              "arroyo",
              "barceloneta",
              "barranquitas",
              "bayamon",
              "cabo-rojo",
              "caguas",
              "camuy",
              "canovanas",
              "carolina",
              "carolina-isla-verde",
              "catano",
              "cayey",
              "ceiba",
              "ciales",
              "cidra",
              "coamo",
              "comerio",
              "corozal",
              "culebra",
              "dorado",
              "fajardo",
              "florida",
              "guanica",
              "guayama",
              "guayanilla",
              "guaynabo",
              "gurabo",
              "hatillo",
              "hormigueros",
              "humacao",
              "humacao-palmas",
              "isabela",
              "jayuya",
              "juana-diaz",
              "juncos",
              "lajas",
              "lares",
              "las-marias",
              "las-piedras",
              "loiza",
              "luquillo",
              "manati",
              "maricao",
              "maunabo",
              "mayaguez",
              "moca",
              "morovis",
              "naguabo",
              "naranjito",
              "orocovis",
              "patillas",
              "penuelas",
              "ponce",
              "quebradillas",
              "rincon",
              "rio-grande",
              "sabana-grande",
              "salinas",
              "san-german",
              "san-juan-condado-miramar",
              "san-juan-hato-rey",
              "san-juan-rio-piedras",
              "san-juan-santurce",
              "san-juan-viejo-sj",
              "san-lorenzo",
              "san-sebastian",
              "santa-isabel",
              "toa-alta",
              "toa-baja",
              "toa-baja-levittown",
              "trujillo-alto",
              "utuado",
              "vega-alta",
              "vega-baja",
              "vieques",
              "villalba",
              "yabucoa",
              "yauco"
            ],
            "type": "string",
            "description": "A municipality, one of the San Juan areas, or a whole region. San Juan is split into five areas on ClasificadosOnline; the Metro region covers all of them plus Bayamón, Carolina, Guaynabo and the rest of the metro area.",
            "default": "san-juan-condado-miramar"
          },
          "keyword": {
            "title": "🔎 Near or keyword",
            "type": "string",
            "description": "Optional. A neighbourhood, urbanización, building or word, for example Condado, Dorado Beach or Palmas del Mar. ClasificadosOnline matches it against the advert's location and text."
          },
          "minPrice": {
            "title": "💵 Price from (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Lowest asking price in US dollars; for rentals, the monthly rent. Leave empty for no floor."
          },
          "maxPrice": {
            "title": "💰 Price up to (USD)",
            "minimum": 0,
            "type": "integer",
            "description": "Highest asking price in US dollars; for rentals, the monthly rent. Leave empty for no ceiling."
          },
          "bedrooms": {
            "title": "🛏️ Bedrooms",
            "enum": [
              "any",
              "efficiency",
              "1",
              "2",
              "3",
              "4",
              "5",
              "6plus"
            ],
            "type": "string",
            "description": "Exact number of bedrooms, as ClasificadosOnline filters it: 3 returns three-bedroom adverts only.",
            "default": "any"
          },
          "listedBy": {
            "title": "🙋 Listed by",
            "enum": [
              "any",
              "brokerage",
              "individual"
            ],
            "type": "string",
            "description": "Brokerage accounts are real-estate companies with a ClasificadosOnline partner profile; the row names the brokerage. Individual accounts are everyone else: private owners and landlords, plus some independent agents. Adverts that do not match are skipped and never charged.",
            "default": "any"
          },
          "includeRepossessed": {
            "title": "🏦 Include repossessed homes",
            "type": "boolean",
            "description": "For-sale searches only. Keep bank-owned (reposeídas) properties in the results, as the site does by default.",
            "default": true
          },
          "includeUnderOption": {
            "title": "📝 Include homes under option",
            "type": "boolean",
            "description": "For-sale searches only. Keep properties already under option (opcionadas) in the results, as the site does by default.",
            "default": true
          },
          "petsAllowed": {
            "title": "🐾 Pets allowed",
            "type": "boolean",
            "description": "Rentals only. Return only rentals that accept pets.",
            "default": false
          },
          "section8": {
            "title": "🏛️ Section 8 (Plan 8)",
            "type": "boolean",
            "description": "Rentals only. Return only rentals that accept Section 8 (Plan 8) housing vouchers.",
            "default": false
          },
          "parking": {
            "title": "🚗 Parking",
            "type": "boolean",
            "description": "Rentals only. Return only rentals with parking.",
            "default": false
          },
          "maxResults": {
            "title": "🔢 Properties to collect",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many properties to return. Pages hold 30, so a run stops on the page that reaches this number.",
            "default": 100
          },
          "includeDetails": {
            "title": "📄 Open each advert in full",
            "type": "boolean",
            "description": "Also open every advert page for the full headline and description, square feet and every photo. On brokerage adverts it adds the agent's name and phone; individual accounts never get a name or phone. Billed as one Property Detail on top of the search row.",
            "default": false
          },
          "listingUrls": {
            "title": "🔗 Advert URLs",
            "type": "array",
            "description": "ClasificadosOnline advert addresses for Property Detail, one per line, for example https://www.clasificadosonline.com/UDRealEstateDetail.asp?ID=4897480 (for sale) or https://www.clasificadosonline.com/UDRentalsDetail.asp?ReForRentAdID=1973706 (for rent).",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}