{ "openapi": "3.0.1", "info": { "title": "$0.80/1K 💰 QuintoAndar Scraper Brazil", "description": "Extrai dados estruturados (preço, R$/m², condomínio, IPTU, endereço, pontos de interesse próximos, comodidades, fotos e vídeos) de imóveis do QuintoAndar, a partir de estado/cidade/bairro e filtros (tipo, preço, quartos, banheiros, área).", "version": "0.1", "x-build-id": "CO6R2qGLC9BlnikmU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/extractmaster01~quintoandar-scraper-brazil/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-extractmaster01-quintoandar-scraper-brazil", "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/extractmaster01~quintoandar-scraper-brazil/runs": { "post": { "operationId": "runs-sync-extractmaster01-quintoandar-scraper-brazil", "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/extractmaster01~quintoandar-scraper-brazil/run-sync": { "post": { "operationId": "run-sync-extractmaster01-quintoandar-scraper-brazil", "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": [ "state", "transactionType" ], "properties": { "state": { "title": "Estado (UF)", "type": "string", "description": "Sigla do estado, ex.: 'SP', 'RJ', 'MG'. Sempre obrigatório. Deixe 'Cidade' vazio para buscar o estado inteiro." }, "transactionType": { "title": "Tipo de transação", "enum": [ "rent", "sale" ], "type": "string", "description": "Aluguel ou venda. Obrigatório: sem esse campo a busca fica ambígua entre os dois tipos de anúncio." }, "city": { "title": "Cidade (opcional)", "type": "string", "description": "Nome da cidade para restringir a busca, ex.: 'São Paulo'. Deixe vazio para buscar o estado inteiro." }, "region": { "title": "Bairro (opcional)", "type": "string", "description": "Bairro/região para restringir ainda mais a busca, ex.: 'Vila Madalena'. Só filtra de verdade no servidor quando 'Cidade' também está preenchida; sem cidade, vira um pós-filtro aproximado sobre o bairro extraído de cada imóvel." }, "propertyType": { "title": "Tipo de imóvel", "enum": [ "all", "apartamento", "casa", "casacondominio", "kitnet" ], "type": "string", "description": "Filtro opcional de tipo. São os únicos 4 tipos que o QuintoAndar lista no próprio site; não existe 'terreno' nem 'comercial' no catálogo dele.", "default": "all" }, "priceMin": { "title": "Preço mínimo (R$)", "minimum": 0, "type": "integer", "description": "Preço mínimo (aluguel mensal ou preço de venda, conforme 'Tipo de transação')." }, "priceMax": { "title": "Preço máximo (R$)", "minimum": 0, "type": "integer", "description": "Preço máximo. Mesma regra de 'Preço mínimo'." }, "bedroomsMin": { "title": "Mínimo de quartos", "minimum": 1, "type": "integer", "description": "Número mínimo de quartos ('N ou mais', não exato)." }, "bathroomsMin": { "title": "Mínimo de banheiros", "minimum": 1, "maximum": 4, "type": "integer", "description": "Número mínimo de banheiros ('N ou mais'). Limitado a 4, que já significa '4 ou mais' no site." }, "areaMin": { "title": "Área mínima (m²)", "minimum": 1, "type": "integer", "description": "Área útil mínima em m²." }, "maxListings": { "title": "Máximo de imóveis", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Limite de imóveis extraídos no run. Deixe vazio para não limitar (aplica um teto de segurança generoso em vez de tentar esgotar a busca inteira; veja 'Limitações conhecidas' no README).", "default": 12 }, "extractVideos": { "title": "Extrair vídeos (opcional)", "type": "boolean", "description": "Busca os vídeos de cada anúncio (campo 'videos'). Exige uma chamada de rede extra por imóvel, deixando o run mais lento. Desligado por padrão.", "default": false }, "acceptPets": { "title": "Aceita pets (opcional)", "enum": [ "", "yes", "no" ], "type": "string", "description": "Filtra por imóveis que aceitam ou não animais de estimação. Deixe vazio para não filtrar.", "default": "" }, "closeToSubway": { "title": "Perto de metrô (opcional)", "enum": [ "", "yes", "no" ], "type": "string", "description": "Filtra por imóveis perto de estação de metrô. Deixe vazio para não filtrar.", "default": "" }, "skipKnownListings": { "title": "Pular imóveis já extraídos antes (opcional)", "type": "boolean", "description": "Lembra os imóveis já extraídos em runs anteriores (por até 30 dias) e pula eles neste run. Útil para runs recorrentes (ex.: diário). Desligado por padrão.", "default": false }, "proxyConfiguration": { "title": "Configuração de Proxy", "type": "object", "description": "Proxies do Apify a usar. Datacenter é o padrão e costuma bastar; ative residencial só se você notar bloqueios recorrentes (custa mais)." } } }, "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 } } }, "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 } } } } } } } } } }