{ "openapi": "3.0.1", "info": { "title": "QuintoAndar Scraper & New-Listing Monitor - Brazil Rent & Sale", "description": "For renters, buyers and Brazil real estate research: QuintoAndar listings as an API by city or neighbourhood. Rent (aluguel), condomínio, IPTU and total monthly cost in BRL as separate numbers, sale price, m², bedrooms, parking, coordinates. Monitoring returns only new listings and price drops.", "version": "0.1", "x-build-id": "thUjv7dKJNvAD2kg8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neverempty~quintoandar-listings-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neverempty-quintoandar-listings-monitor", "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/neverempty~quintoandar-listings-monitor/runs": { "post": { "operationId": "runs-sync-neverempty-quintoandar-listings-monitor", "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/neverempty~quintoandar-listings-monitor/run-sync": { "post": { "operationId": "run-sync-neverempty-quintoandar-listings-monitor", "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": { "transaction": { "title": "Rent or buy", "enum": [ "rent", "buy" ], "type": "string", "description": "rent = listings for rent (alugar), buy = listings for sale (comprar). Ignored when a QuintoAndar search URL is given; empty = rent." }, "city": { "title": "City", "type": "string", "description": "The city as people write it, e.g. São Paulo, Rio de Janeiro, Belo Horizonte, Curitiba (accents optional), or QuintoAndar's own location code such as sao-paulo-sp-brasil. Required unless a search URL is given." }, "state": { "title": "State (UF)", "type": "string", "description": "Two-letter Brazilian state code of the city, e.g. SP, RJ, MG, PR, DF. Needed when the city is written as a name; not needed with a location code like sao-paulo-sp-brasil." }, "neighbourhood": { "title": "Neighbourhood (bairro)", "type": "string", "description": "Optional neighbourhood inside the city, e.g. Vila Mariana, Pinheiros, Copacabana. Empty = the whole city. Splitting a large city by neighbourhood also lets monitoring cover more listings (QuintoAndar serves at most 1,000 per search)." }, "searchUrl": { "title": "QuintoAndar search URL", "type": "string", "description": "Optional: paste a QuintoAndar list address such as https://www.quintoandar.com.br/comprar/imovel/rio-de-janeiro-rj-brasil. When given, rent/buy, city, state and neighbourhood are taken from it and the fields above are ignored. Filters in the URL are not carried over; use the filters below." }, "maxListings": { "title": "Maximum listings to return", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many listings to return, newest first. You are charged only for rows you receive. QuintoAndar serves at most 1,000 listings per search; empty = 20." }, "maxPages": { "title": "Maximum pages to read", "minimum": 0, "maximum": 20, "type": "integer", "description": "Hard cap on pages of 50 listings requested (at most 20). 0 or empty = decided from maxListings (monitoring: all 20 pages). Outside monitoring, reading pages is free and only returned listings are charged; in monitoring mode each page compared without a change is charged one search-checked event." }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Keep listings at or above this price in reais: monthly rent for rent searches, sale price for buy searches. 0 or empty = no minimum. Listings without a price are kept." }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Keep listings at or below this price in reais, e.g. 4000 for rent or 800000 for a purchase. 0 or empty = no maximum." }, "minAreaSqm": { "title": "Minimum area (m²)", "minimum": 0, "type": "number", "description": "Keep listings with at least this usable area in square metres. 0 or empty = no minimum." }, "maxAreaSqm": { "title": "Maximum area (m²)", "minimum": 0, "type": "number", "description": "Keep listings with at most this usable area in square metres. 0 or empty = no maximum." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Keep listings with at least this many bedrooms (quartos). 0 or empty = any." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only these property types: Apartment (Apartamento), House (Casa), House in a gated condominium (Casa de Condomínio), Studio / kitchenette (Kitnet, Studio). English or Portuguese names both work. Empty = all types.", "items": { "type": "string" } }, "furnishedOnly": { "title": "Furnished only", "type": "boolean", "description": "On: drop listings QuintoAndar marks as not furnished. Off: keep all.", "default": false }, "includeNearby": { "title": "Include nearby suggestions", "type": "boolean", "description": "QuintoAndar mixes in listings from nearby places (the next neighbourhood or city). Off: return only listings QuintoAndar tags as being in the city or neighbourhood you searched. On: also return the others (areaMatch = inside-area-bounds or nearby).", "default": false }, "monitoringMode": { "title": "Monitoring mode (new listings and price drops only)", "type": "boolean", "description": "On: the first run remembers every listing and its price (free); every later run returns only listings that are new or cheaper since the last run, with changeType and previousPriceBrl. Off: return the current listings.", "default": false }, "resetMonitoringState": { "title": "Reset monitoring memory", "type": "boolean", "description": "On: forget what monitoring remembered for this search, so the next monitoring run starts again from a free baseline. Off: keep the memory.", "default": false } } }, "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 } } } } } } } } } }