{ "openapi": "3.0.1", "info": { "title": "QuintoAndar Scraper — Brazil Rentals & Homes for Sale", "description": "Scrape QuintoAndar, Brazil's rental and home-sale platform: rent, total monthly cost, condo fee, IPTU, sale price, price per m², area, bedrooms, parking, address, neighbourhood and photos, by city or neighbourhood with filters. Optional coordinates, ZIP and dates. No login.", "version": "0.1", "x-build-id": "N7UqmoNWtsmlqkuNm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~quintoandar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-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/yugenox~quintoandar-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-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/yugenox~quintoandar-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-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", "properties": { "locations": { "title": "📍 Cities or neighbourhoods", "type": "array", "description": "Where to search. A city (\"São Paulo\", \"Rio de Janeiro\", \"Belo Horizonte\", \"Curitiba\" …), a neighbourhood with its city (\"Pinheiros, São Paulo\", \"Copacabana, Rio de Janeiro\"), a city with its state (\"Campinas, SP\") or a QuintoAndar location slug (\"pinheiros-sao-paulo-sp-brasil\"). Each one is a separate search.", "items": { "type": "string" } }, "dealType": { "title": "Rent or buy", "enum": [ "rent", "sale", "both" ], "type": "string", "description": "Homes for rent (aluguel), homes for sale (compra), or both (every location is searched twice). A home listed for both appears once.", "default": "rent" }, "startUrls": { "title": "🔗 QuintoAndar URLs", "type": "array", "description": "Optional: QuintoAndar search URLs (quintoandar.com.br/alugar/imovel/pinheiros-sao-paulo-sp-brasil/apartamento/2-quartos — type, bedrooms, price and area in the URL are kept) or listing URLs (quintoandar.com.br/imovel/895825983/comprar/…, always read with full details).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings", "minimum": 0, "maximum": 200000, "type": "integer", "description": "Maximum number of listings for the whole run, shared fairly between your searches. 0 = everything (a big city has tens of thousands).", "default": 100 }, "includeDetails": { "title": "Include listing details", "type": "boolean", "description": "Also open each listing's own page for coordinates (about 100 m precision), ZIP code, listing code, floor range, publication dates, the owner's description, places nearby, pets / metro and every photo. Charged as an extra \"listing details\" event per listing (see Pricing); slower.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "price_asc", "price_desc" ], "type": "string", "description": "Order of the results, as on QuintoAndar. Price = total monthly cost for rentals, sale price for sales.", "default": "relevance" }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Skip listings an earlier run with the same input already saved (they are not saved or charged again). Ideal for a daily schedule together with \"Newest first\".", "default": false }, "minPrice": { "title": "Min price (R$)", "minimum": 0, "type": "integer", "description": "Minimum monthly rent (rentals) or sale price (sales), in reais." }, "maxPrice": { "title": "Max price (R$)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent (rentals) or sale price (sales), in reais." }, "maxTotalMonthlyCost": { "title": "Max total monthly cost (R$, rentals)", "minimum": 0, "type": "integer", "description": "Rentals only: maximum total per month (rent + condominium + IPTU + fees), as QuintoAndar shows it." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these property types. Empty = all.", "items": { "type": "string", "enum": [ "APARTMENT", "HOUSE", "HOUSE_CONDO", "STUDIO" ], "enumTitles": [ "Apartment", "House", "House in a gated community", "Studio / kitchenette" ] } }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "At least this many bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "At least this many bathrooms." }, "minParkingSpaces": { "title": "Min parking spaces", "minimum": 0, "type": "integer", "description": "At least this many parking spaces." }, "minSuites": { "title": "Min suites", "minimum": 0, "type": "integer", "description": "At least this many suites (bedrooms with their own bathroom)." }, "minArea": { "title": "Min area (m²)", "minimum": 0, "type": "integer", "description": "Minimum usable area in square metres." }, "maxArea": { "title": "Max area (m²)", "minimum": 0, "type": "integer", "description": "Maximum usable area in square metres." }, "furnished": { "title": "Furnished", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Furnished homes only, unfurnished only, or any.", "default": "any" }, "acceptsPets": { "title": "Accepts pets", "type": "boolean", "description": "Only homes that accept pets.", "default": false }, "nearSubway": { "title": "Near the metro", "type": "boolean", "description": "Only homes near a metro station.", "default": false }, "onlyExactLocation": { "title": "Only exact location", "type": "boolean", "description": "QuintoAndar adds homes from nearby areas to a neighbourhood search (the nearbyMatch column says which). Turn this on to leave them out (they are not charged).", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and is all this scraper needs.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }