{
"openapi": "3.0.1",
"info": {
"title": "QuintoAndar Scraper: Brazil Rent & Sale Listings",
"description": "Scrape QuintoAndar rental and for-sale listings in Brazil by city or neighbourhood: rent, condo fee, IPTU, total cost, sale price, area, rooms, parking, address, CEP, coordinates and amenities. No login. $3 per 1,000 listings.",
"version": "0.1",
"x-build-id": "6ibHXNd9outqNK6oE"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/cprussin~quintoandar-listings/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-cprussin-quintoandar-listings",
"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/cprussin~quintoandar-listings/runs": {
"post": {
"operationId": "runs-sync-cprussin-quintoandar-listings",
"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/cprussin~quintoandar-listings/run-sync": {
"post": {
"operationId": "run-sync-cprussin-quintoandar-listings",
"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": "Locations",
"type": "array",
"description": "QuintoAndar city or neighbourhood slugs, as in quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil: sao-paulo-sp-brasil, rio-de-janeiro-rj-brasil, pinheiros-sao-paulo-sp-brasil. Names like Campinas SP work too.",
"items": {
"type": "string"
}
},
"businessType": {
"title": "Rent or buy",
"enum": [
"rent",
"buy"
],
"type": "string",
"description": "Search rentals (alugar) or properties for sale (comprar).",
"default": "rent"
},
"startUrls": {
"title": "Start URLs",
"type": "array",
"description": "Optional QuintoAndar search pages, e.g. https://www.quintoandar.com.br/comprar/imovel/campinas-sp-brasil, or listing pages, e.g. https://www.quintoandar.com.br/imovel/892807587.",
"items": {
"type": "string"
}
},
"includeNeighbourhoods": {
"title": "Include neighbourhood pages",
"type": "boolean",
"description": "QuintoAndar shows 24 listings per search page and has no paging, so after a city's page the actor continues with every neighbourhood page of that city (from QuintoAndar's sitemap) until Max listings. Turn off for just the city page.",
"default": true
},
"minPrice": {
"title": "Min price (BRL)",
"minimum": 0,
"type": "integer",
"description": "Only listings with at least this rent (rent) or sale price (buy), in reais."
},
"maxPrice": {
"title": "Max price (BRL)",
"minimum": 0,
"type": "integer",
"description": "Only listings with at most this rent (rent) or sale price (buy), in reais."
},
"minBedrooms": {
"title": "Min bedrooms",
"minimum": 0,
"type": "integer",
"description": "Only listings with at least this many bedrooms."
},
"maxItems": {
"title": "Max listings",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Stop after this many listings in total. Each listing is billed as one listing.",
"default": 20
},
"includeDetails": {
"title": "Include listing details",
"type": "boolean",
"description": "Open each listing page for the separate condo fee and IPTU, coordinates, CEP, suites, floor, pets, building name, construction year, description and dates (one extra request per listing, same price). Off: search data only (rent, sale price, total cost, condo + IPTU, area, rooms, street, neighbourhood, amenities, photos).",
"default": true
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Apify Proxy (datacenter is enough). The actor switches to a new IP whenever a request is blocked or fails, and falls back to direct requests if the proxy keeps failing.",
"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
}
}
}
}
}
}
}
}
}
}