{ "openapi": "3.0.1", "info": { "title": "QuintoAndar Scraper - Property Listings, Prices & Amenities", "description": "Scrape QuintoAndar property listings across Brazil with 80+ fields, including rent, sale price, condo fees, IPTU, area, rooms, parking, GPS, photos, amenities, and descriptions. Supports search, URLs, sorting, and price, area, and bedroom filters.", "version": "1.0", "x-build-id": "QAVobriGvx9KDwa2C" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~quintoandar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-quintoandar-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/abotapi~quintoandar-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-quintoandar-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/abotapi~quintoandar-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-quintoandar-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", "required": [ "mode" ], "properties": { "mode": { "title": "Search mode", "enum": [ "search", "url" ], "type": "string", "description": "search = build searches from location names + filters. url = paste one or more quintoandar results-page URLs.", "default": "search" }, "locations": { "title": "Locations", "type": "array", "description": "Location names to search, e.g. São Paulo, Rio de Janeiro, Pinheiros São Paulo, Belo Horizonte. Accents and spaces are handled automatically. Only applies when mode = search.", "items": { "type": "string" } }, "operationType": { "title": "Operation", "enum": [ "rent", "sale" ], "type": "string", "description": "Rent or buy. Only applies when mode = search.", "default": "rent" }, "propertyType": { "title": "Property type", "enum": [ "all", "apartment", "house", "studio", "condo_house" ], "type": "string", "description": "Property category to search. 'All' covers every type. Applies in Search mode and URL mode, including a pasted URL.", "default": "all" }, "propertyTypes": { "title": "Property types (multi-select)", "type": "array", "description": "Pick several property categories at once. When set, it replaces the single Property type above. Applies in Search mode and URL mode.", "items": { "type": "string", "enum": [ "apartment", "house", "studio", "condo_house" ], "enumTitles": [ "Apartment (apartamento)", "House (casa)", "Studio/Kitnet", "Condo house (casa de condomínio)" ] } }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum total monthly cost (rent) or sale price, in BRL. Applies in Search mode and URL mode, including a pasted URL." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum total monthly cost (rent) or sale price, in BRL. Applies in Search mode and URL mode, including a pasted URL." }, "minArea": { "title": "Min area (m2)", "minimum": 0, "type": "integer", "description": "Minimum area in square metres. Applies in Search mode and URL mode, including a pasted URL." }, "maxArea": { "title": "Max area (m2)", "minimum": 0, "type": "integer", "description": "Maximum area in square metres. Applies in Search mode and URL mode, including a pasted URL." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 1, "type": "integer", "description": "Minimum number of bedrooms (quartos). Applies in Search mode and URL mode, including a pasted URL." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 1, "type": "integer", "description": "Minimum number of bathrooms. Applies in Search mode and URL mode." }, "minParking": { "title": "Min parking spaces", "minimum": 0, "type": "integer", "description": "Minimum number of parking spaces. Applies in Search mode and URL mode." }, "neighborhood": { "title": "Neighbourhood", "type": "string", "description": "Optional neighbourhood (bairro) added to every location, e.g. Pinheiros with location São Paulo. Search mode only." }, "furnished": { "title": "Furnished", "enum": [ "all", "furnished", "unfurnished" ], "type": "string", "description": "Furnished listings only, or exclude furnished listings (unfurnished is applied after the fetch, from the furnished flag when the site exposes it). Applies in Search mode and URL mode.", "default": "all" }, "petsAllowed": { "title": "Pets allowed", "type": "boolean", "description": "Only listings that accept pets. Applies in Search mode and URL mode.", "default": false }, "nearTransit": { "title": "Near subway / transit", "type": "boolean", "description": "Only listings near a subway station. Applies in Search mode and URL mode.", "default": false }, "amenities": { "title": "Property amenities", "type": "array", "description": "Only listings that have ALL selected in-unit amenities.", "items": { "type": "string", "enum": [ "air_conditioning", "barbecue_grill", "gas_shower", "walk_in_closet", "garden_private_outdoor_area", "private_pool", "laundry_sink", "television", "kitchen_utensils", "ceiling_fan" ], "enumTitles": [ "Air conditioning", "Barbecue grill", "Gas shower", "Walk in closet", "Garden private outdoor area", "Private pool", "Laundry sink", "Television", "Kitchen utensils", "Ceiling fan" ] } }, "condoAmenities": { "title": "Condo / building amenities", "type": "array", "description": "Only listings whose building has ALL selected amenities.", "items": { "type": "string", "enum": [ "gym", "green_area", "playroom", "barbecue_area", "elevator", "swimming_pool", "playground", "24_hour_concierge", "sports_court", "party_room", "game_room", "sauna" ], "enumTitles": [ "Gym", "Green area", "Playroom", "Barbecue area", "Elevator", "Swimming pool", "Playground", "24 hour concierge", "Sports court", "Party room", "Game room", "Sauna" ] } }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "price-asc", "price-desc", "newest", "closest" ], "type": "string", "description": "Result ordering. Applies in Search mode and URL mode, including a pasted URL.", "default": "relevance" }, "urls": { "title": "Results-page URLs", "type": "array", "description": "Paste one or more quintoandar.com.br URLs: results pages (city or neighbourhood, with an optional property type, bedroom count, mobiliado segment or ?ordenar= / ?preco= query) or single property pages (/imovel/{id}). Filters and sort carried by a pasted results URL are applied and win over the fields above. Unsupported parts of a URL are logged as warnings. Location and operation above are ignored in this mode; property type, price, area, bedroom and sort filters above still apply to results URLs that do not set their own.", "default": [ "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil", "https://www.quintoandar.com.br/comprar/imovel/sao-paulo-sp-brasil", "https://www.quintoandar.com.br/alugar/imovel/pinheiros-sao-paulo-sp-brasil", "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil/apartamento", "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil/casa", "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil/2-quartos", "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil/mobiliado", "https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil?ordenar=menor-preco&preco=1000-3000", "https://quintoandar.com.br/comprar/imovel/belo-horizonte-mg-brasil", "https://www.quintoandar.com.br/imovel/894090267/alugar", "https://www.quintoandar.com.br/imovel/895818343/comprar", "https://www.quintoandar.com.br/imovel/894317939", "https://www.quintoandar.com.br/imovel/895097594/alugar/apartamento-2-quartos-pinheiros-sao-paulo" ], "items": { "type": "string" } }, "fetchDetails": { "title": "Fetch full detail from each property page", "type": "boolean", "description": "Fetch each property page to add GPS coordinates, the full description, in-unit and building amenities, condo and IPTU breakdown, floor, and furnished / pets / subway flags. Adds one request per property. Leave on for the richest output.", "default": true }, "maxPages": { "title": "Max pages per search", "minimum": 1, "type": "integer", "description": "Optional safety stop on how many result pages to read per location/URL. This does NOT cap the run: leave it empty (or 0) to use the built-in hard ceiling of 1000 pages per search (about 11,000 listings), which applies even when Max listings is 0. Set a lower value if you want a tighter per-search page ceiling." }, "maxListings": { "title": "Max listings", "minimum": 0, "type": "integer", "description": "The run's single hard cap: maximum total listings across all searches. Defaults to 20. Set 0 for unlimited. This is the only default limit; Max pages falls back to a built-in hard ceiling of 1000 pages per search.", "default": 20 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Connection used for requests. The default works on any Apify plan, including the free tier." }, "resumeFromRunId": { "title": "Resume from a previous run", "type": "string", "description": "Paste a previous run ID or dataset ID to continue a large catalogue pull without returning or charging for listings already collected there. Use this after an interrupted run. For recurring daily monitoring of the same search, use Incremental mode below instead." }, "incrementalMode": { "title": "Incremental changes for scheduled runs", "type": "boolean", "description": "Turn this on for daily or recurring monitoring. The first run returns every matching listing as NEW. Later runs normally return only NEW, UPDATED and REAPPEARED listings, which is how a price cut or a stock change is spotted. Turn on Emit unchanged or Emit expired only when you also want those rows returned (and billed). State is kept separately for each search, filter and detail setup; use State key to name or deliberately share a monitoring campaign. To continue one specific interrupted run instead, use Resume from a previous run above.", "default": false }, "stateKey": { "title": "State key (optional, incremental mode only)", "type": "string", "description": "Optional. Name this monitoring campaign to keep its state stable, or to deliberately share state across differently configured runs. Leave empty to let the actor derive a key automatically from the search, filters and detail settings, so different searches never mix state with each other." }, "emitUnchanged": { "title": "Emit unchanged products (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that have not changed since the last run, marked UNCHANGED. This returns, and bills, extra rows you already have, so leave it off unless you want the full snapshot every run.", "default": false }, "emitExpired": { "title": "Emit expired products (incremental mode only)", "type": "boolean", "description": "Off by default. Turn on to also return listings that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search, so never when Max listings capped it or when Resume was used. This returns, and bills, extra synthetic rows, so leave it off unless you need expiry tracking.", "default": false }, "ignoreFieldsForChanges": { "title": "Ignore fields when detecting changes (incremental mode only)", "type": "array", "description": "Incremental mode only. Fields whose changes do not count as an update: a change in them alone leaves the listing UNCHANGED and they are not listed in changedFields. They are still returned in every row. Use a dotted path for a nested field. The run timestamps (scrapedAt, coletadoEm, vistoPrimeiraVez, vistoUltimaVez) are always ignored. Add more field names here to ignore them as well, for example precoCondominio.", "items": { "type": "string" } }, "mcpConnectors": { "title": "Pipe results into your apps (optional)", "type": "array", "description": "Optionally send the scraped results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize a connector once under Apify, Settings, Integrations, then select it here. The connector receives a condensed, human-readable summary per item (title + key fields), not the full JSON; the complete record stays in the dataset. Leave empty to skip. Supported: Notion (https://mcp.notion.com/mcp), Linear (https://mcp.linear.app/sse), Airtable (https://mcp.airtable.com/mcp), Apify (https://mcp.apify.com)." }, "notionParentPageUrl": { "title": "Notion parent page (Notion connector only)", "type": "string", "description": "URL (or id) of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors." }, "maxNotifyListings": { "title": "Max items to export per connector", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Cap on items written to each connector per run. Does not affect the dataset.", "default": 50 } } }, "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 } } } } } } } } } }