{ "openapi": "3.0.1", "info": { "title": "QuintoAndar Property Scraper - Brazil Rentals & Homes for Sale", "description": "Scrapes property listings from QuintoAndar (quintoandar.com.br), Brazil's rental and home sale platform: rent, sale price, condo fee, IPTU, total cost, area, rooms, address, coordinates, amenities, photos and description. Search by city or neighbourhood, search URL or property URL.", "version": "1.0", "x-build-id": "90MVDtKUdps52ZO2K" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/confidential_gnat~quintoandar-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-confidential_gnat-quintoandar-property-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/confidential_gnat~quintoandar-property-scraper/runs": { "post": { "operationId": "runs-sync-confidential_gnat-quintoandar-property-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/confidential_gnat~quintoandar-property-scraper/run-sync": { "post": { "operationId": "run-sync-confidential_gnat-quintoandar-property-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": { "startUrls": { "title": "Search or property URLs", "type": "array", "description": "QuintoAndar search URLs (for example https://www.quintoandar.com.br/alugar/imovel/sao-paulo-sp-brasil/apartamento/2-quartos) or property URLs (for example https://www.quintoandar.com.br/imovel/895457778). Filters in a search URL are kept; the keyword, location and filter fields below are optional and apply only to Locations.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "scrapeDetails": { "title": "Scrape property details", "type": "boolean", "description": "Open every property page to get the full description, condo fee, service fee, fire insurance, ZIP code, floor, condominium name, photos with room labels, move-in terms, deposit range, nearby places and publication dates. Turn off for faster runs with the search data only. Property URLs always include the details.", "default": true }, "cacheProjectName": { "title": "Cache project name", "type": "string", "description": "Use the same name on each scheduled run to get only new listings. Properties already scraped under this name are skipped and not charged, and they do not count towards Max items. Each record gets changeType: new." }, "maxItems": { "title": "Max items per search", "minimum": 1, "type": "integer", "description": "Maximum unique properties saved for each location or search URL. QuintoAndar shows at most 1,000 results per search, so above 1,000 the actor splits the search by property type and price automatically.", "default": 5 }, "locations": { "title": "Locations", "type": "array", "description": "Cities or neighbourhoods to search, for example \"São Paulo, SP\", \"Pinheiros, São Paulo, SP\" or a QuintoAndar slug like rio-de-janeiro-rj-brasil. Include the state code. Each location is searched separately with the filters below.", "default": [], "items": { "type": "string" } }, "businessType": { "title": "Rent or buy", "enum": [ "RENT", "SALE" ], "type": "string", "description": "Search rentals or properties for sale. Applies to Locations.", "default": "RENT" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these property types. Leave empty for all.", "items": { "type": "string", "enum": [ "Apartamento", "Casa", "CasaCondominio", "StudioOuKitchenette" ], "enumTitles": [ "Apartment", "House", "House in a gated community", "Studio / kitchenette" ] }, "default": [] }, "minPrice": { "title": "Min price (R$)", "minimum": 0, "type": "integer", "description": "Minimum monthly total cost for rentals (rent + condo + IPTU + fees) or minimum sale price." }, "maxPrice": { "title": "Max price (R$)", "minimum": 0, "type": "integer", "description": "Maximum monthly total cost for rentals or maximum sale price." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 1, "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 1, "type": "integer", "description": "Minimum number of bathrooms." }, "minParkingSpots": { "title": "Min parking spots", "minimum": 1, "type": "integer", "description": "Minimum number of parking spots." }, "minArea": { "title": "Min area (m²)", "minimum": 0, "type": "integer", "description": "Minimum floor area in square metres." }, "maxArea": { "title": "Max area (m²)", "minimum": 0, "type": "integer", "description": "Maximum floor area in square metres." }, "furnished": { "title": "Furnished only", "type": "boolean", "description": "Only furnished properties.", "default": false }, "petsAllowed": { "title": "Pets allowed only", "type": "boolean", "description": "Only properties that accept pets.", "default": false }, "nearSubway": { "title": "Near subway only", "type": "boolean", "description": "Only properties near a subway or train station.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "RELEVANCE", "MOST_RECENT", "LOWEST_PRICE", "HIGHEST_PRICE" ], "type": "string", "description": "Order of the results. Use Most recent with a cache project name to pick up new listings on scheduled runs.", "default": "RELEVANCE" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "This website works without a proxy. Enable Apify Proxy only if you get blocked.", "default": { "useApifyProxy": 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 } } } } } } } } } }