{
  "openapi": "3.0.1",
  "info": {
    "title": "QuintoAndar & OLX Imóveis Scraper: Aluguel e Venda",
    "description": "Rent and sale listings from QuintoAndar, OLX Imóveis, Chaves na Mão and Imovelweb in one flat dataset: price, condo fee, IPTU, total monthly cost, area, bedrooms, coordinates and photos. Search by city and neighborhood with filters for price, area, bedrooms and pets. No login or API key.",
    "version": "0.1",
    "x-build-id": "5DIK6E2CyphJgQOgo"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/allanmxr~brazil-real-estate-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-allanmxr-brazil-real-estate-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/allanmxr~brazil-real-estate-scraper/runs": {
      "post": {
        "operationId": "runs-sync-allanmxr-brazil-real-estate-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/allanmxr~brazil-real-estate-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-allanmxr-brazil-real-estate-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": {
          "sources": {
            "title": "Sources",
            "minItems": 1,
            "uniqueItems": true,
            "type": "array",
            "description": "Portals to search. The listing budget (Max items) is shared equally between them.",
            "items": {
              "type": "string",
              "enum": [
                "quintoandar",
                "olx",
                "chavesnamao",
                "imovelweb"
              ],
              "enumTitles": [
                "QuintoAndar",
                "OLX Imóveis",
                "Chaves na Mão",
                "Imovelweb"
              ]
            },
            "default": [
              "quintoandar",
              "olx",
              "chavesnamao",
              "imovelweb"
            ]
          },
          "dealType": {
            "title": "Deal type",
            "enum": [
              "rent",
              "sale"
            ],
            "type": "string",
            "description": "Rent or buy.",
            "default": "rent"
          },
          "state": {
            "title": "State",
            "enum": [
              "AC",
              "AL",
              "AP",
              "AM",
              "BA",
              "CE",
              "DF",
              "ES",
              "GO",
              "MA",
              "MT",
              "MS",
              "MG",
              "PA",
              "PB",
              "PR",
              "PE",
              "PI",
              "RJ",
              "RN",
              "RS",
              "RO",
              "RR",
              "SC",
              "SP",
              "SE",
              "TO"
            ],
            "type": "string",
            "description": "State (UF) of the cities below. Not needed when you only paste search URLs."
          },
          "cities": {
            "title": "Cities",
            "type": "array",
            "description": "City names only, one per line, for example Campinas. They must belong to the state above.",
            "items": {
              "type": "string"
            }
          },
          "neighborhoods": {
            "title": "Neighborhoods (optional)",
            "type": "array",
            "description": "Narrow the search to these neighborhoods, for example Cambuí. Works with exactly one city; leave empty to search the whole city.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Search URLs (optional)",
            "type": "array",
            "description": "Search pages copied from quintoandar.com.br (/alugar or /comprar/imovel/...), olx.com.br (/imoveis/...), chavesnamao.com.br (e.g. /apartamentos-para-alugar/sp-campinas/) or imovelweb.com.br (e.g. /apartamentos-aluguel-campinas-sp.html), one per line. They are searched in addition to the cities above, only for the selected sources. An OLX URL keeps its own filters; the other portals only give the place and the deal type, so use the filters below there.",
            "items": {
              "type": "string"
            }
          },
          "propertyTypes": {
            "title": "Property types",
            "type": "array",
            "description": "Leave empty for all residential types. All four portals.",
            "items": {
              "type": "string",
              "enum": [
                "apartment",
                "house",
                "studio",
                "condo_house"
              ],
              "enumTitles": [
                "Apartment",
                "House",
                "Studio / Kitnet",
                "House in a condominium"
              ]
            }
          },
          "minPrice": {
            "title": "Min price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Monthly rent for rentals, asking price for sales. QuintoAndar, OLX, Chaves na Mão and Imovelweb."
          },
          "maxPrice": {
            "title": "Max price (BRL)",
            "minimum": 0,
            "type": "integer",
            "description": "Monthly rent for rentals, asking price for sales. QuintoAndar, OLX, Chaves na Mão and Imovelweb."
          },
          "minArea": {
            "title": "Min area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum usable area. QuintoAndar, OLX, Chaves na Mão and Imovelweb."
          },
          "maxArea": {
            "title": "Max area (m²)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum usable area. QuintoAndar, OLX, Chaves na Mão and Imovelweb."
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "QuintoAndar, OLX, Chaves na Mão and Imovelweb. On OLX 5 means 5 or more."
          },
          "maxBedrooms": {
            "title": "Max bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "QuintoAndar, Imovelweb and Chaves na Mão. On OLX anything above 5 also returns listings with 5 or more."
          },
          "minBathrooms": {
            "title": "Min bathrooms",
            "minimum": 0,
            "type": "integer",
            "description": "QuintoAndar, OLX, Chaves na Mão and Imovelweb. On OLX 5 means 5 or more."
          },
          "minParkingSpots": {
            "title": "Min parking spots",
            "minimum": 0,
            "type": "integer",
            "description": "QuintoAndar, OLX, Chaves na Mão and Imovelweb. On OLX 5 means 5 or more."
          },
          "minSuites": {
            "title": "Min suites",
            "minimum": 0,
            "type": "integer",
            "description": "QuintoAndar, Chaves na Mão and Imovelweb. OLX has no suites filter, so OLX is skipped when this is set."
          },
          "furnished": {
            "title": "Furnished only",
            "type": "boolean",
            "description": "Only furnished properties. QuintoAndar, OLX, Chaves na Mão and Imovelweb.",
            "default": false
          },
          "petFriendly": {
            "title": "Pets allowed only",
            "type": "boolean",
            "description": "Only properties that accept pets. QuintoAndar, OLX and Chaves na Mão. Imovelweb has no pets filter, so Imovelweb is skipped when this is set.",
            "default": false
          },
          "maxCondoFee": {
            "title": "Max condo fee (BRL / month)",
            "minimum": 0,
            "type": "integer",
            "description": "Applied by the actor after the search, on every portal. Listings without a condo fee are kept."
          },
          "publishedWithinDays": {
            "title": "Published in the last N days",
            "minimum": 1,
            "type": "integer",
            "description": "Only listings published or renewed in the last N days, newest first. QuintoAndar, OLX, Chaves na Mão (last update) and Imovelweb (last update). QuintoAndar dates only exist on the listing page, so this opens every candidate listing even with Fetch listing details off."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "relevance",
              "newest"
            ],
            "type": "string",
            "description": "Order of the results, which matters most when Max items is smaller than the number of matches. Newest uses the last publication, renewal or update date. QuintoAndar, OLX, Chaves na Mão and Imovelweb.",
            "default": "relevance"
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "type": "integer",
            "description": "Total listings across all sources.",
            "default": 100
          },
          "fetchDetails": {
            "title": "Fetch listing details",
            "type": "boolean",
            "description": "Opens each listing page to add coordinates, ZIP code, street and, on QuintoAndar, publication dates; on Imovelweb it adds amenities, IPTU and the publication date. Costs one extra request per listing, so turn it off for a much faster run that returns everything else. Chaves na Mão already returns all of that in the search, so it ignores this option.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy configuration (optional)",
            "type": "object",
            "description": "Leave empty: runs start without a proxy and, if a portal blocks or rate-limits (403/429), the actor climbs by itself to Apify Proxy datacenter, then residential in Brazil, then a real browser. On the residential rung the detail pages are skipped (listings keep the search data, without coordinates). Set a proxy here only to replace that default."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}