{ "openapi": "3.0.1", "info": { "title": "Imovelweb Brazil Real Estate Scraper & Monitor", "description": "Extract Imovelweb listings in Brazil for rent and sale with price in reais and dollars, condomínio, IPTU, monthly cost, price per m², quartos, suítes, vagas, GPS, WhatsApp and photos. Filter by bairro, city, owner listings and more, and track new listings and price drops.", "version": "1.0", "x-build-id": "DttSaFXByAuhNWBqv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamole~imovelweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamole-imovelweb-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/datamole~imovelweb-scraper/runs": { "post": { "operationId": "runs-sync-datamole-imovelweb-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/datamole~imovelweb-scraper/run-sync": { "post": { "operationId": "run-sync-datamole-imovelweb-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": "Localizações", "type": "array", "description": "Bairros, cidades ou estados como aparecem no Imovelweb, por exemplo Pinheiros, Moema, Copacabana, Curitiba ou Belo Horizonte.", "items": { "type": "string" } }, "operation": { "title": "Operação", "enum": [ "alugar", "comprar", "temporada", "leilao" ], "type": "string", "description": "Alugar, Comprar, Temporada, Leilão.", "default": "alugar" }, "propertyTypes": { "title": "Tipo de imóvel", "type": "array", "description": "Um ou vários tipos.", "items": { "type": "string", "enum": [ "casa", "apartamento", "terreno", "rural", "comercial" ], "enumTitles": [ "Casa", "Apartamento", "Terreno", "Rural", "Comercial" ] }, "default": [ "apartamento" ] }, "searchUrls": { "title": "URLs de busca", "type": "array", "description": "Opcional. Cole qualquer busca do Imovelweb com seus filtros já aplicados. Todas as páginas são percorridas.", "items": { "type": "string" } }, "maxItems": { "title": "Máximo de anúncios", "minimum": 1, "type": "integer", "description": "Limite para toda a execução. Vazio = sem limite." }, "maxPagesPerSearch": { "title": "Máximo de páginas por busca", "minimum": 1, "type": "integer", "description": "Cada página traz 30 anúncios. Vazio = todas." }, "minPrice": { "title": "Preço mínimo (R$)", "minimum": 0, "type": "integer", "description": "Preço mínimo (R$)" }, "maxPrice": { "title": "Preço máximo (R$)", "minimum": 0, "type": "integer", "description": "Preço máximo (R$)" }, "minCondominium": { "title": "Condomínio mínimo (R$)", "minimum": 0, "type": "integer", "description": "Condomínio mínimo." }, "maxCondominium": { "title": "Condomínio máximo (R$)", "minimum": 0, "type": "integer", "description": "Condomínio máximo." }, "minBedrooms": { "title": "Quartos (mínimo)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Quartos." }, "minBathrooms": { "title": "Banheiros (mínimo)", "minimum": 0, "maximum": 5, "type": "integer", "description": "Banheiros (mínimo)" }, "minParking": { "title": "Vagas (mínimo)", "minimum": 0, "maximum": 4, "type": "integer", "description": "Vagas." }, "minArea": { "title": "Área mínima (m²)", "minimum": 0, "type": "integer", "description": "Área." }, "maxArea": { "title": "Área máxima (m²)", "minimum": 0, "type": "integer", "description": "Área." }, "antiquity": { "title": "Idade do imóvel", "enum": [ "en-construccion", "a-estrenar", "hasta-5", "hasta-10", "hasta-20", "hasta-50", "mas-de-50" ], "type": "string", "description": "Idade máxima do imóvel." }, "publisherType": { "title": "Anunciante", "enum": [ "todos", "inmobiliaria", "dueno-directo" ], "type": "string", "description": "Todos, imobiliária / proprietário direto.", "default": "todos" }, "publishedWithin": { "title": "Publicado", "enum": [ "hoy", "desde-ayer", "ultima-semana", "ultimos-15-dias", "ultimos-30-dias", "ultimos-45-dias" ], "type": "string", "description": "Só anúncios publicados neste período." }, "multimedia": { "title": "Multimídia", "type": "array", "description": "Só anúncios com vídeo, tour 360° ou plantas.", "items": { "type": "string", "enum": [ "video", "recorrido-360", "planos" ], "enumTitles": [ "Vídeos", "Tour 360°", "Plantas" ] } }, "keyword": { "title": "Palavra-chave", "type": "string", "description": "Buscador de palavras do portal. É restrito e retorna poucos anúncios." }, "sort": { "title": "Ordem", "enum": [ "more_recent", "relevance", "low_price", "high_price", "most_lowered_price" ], "type": "string", "description": "Mais recentes percorre a busca completa sem repetidos. Baixaram de preço mostra primeiro as reduções.", "default": "more_recent" }, "includeDetails": { "title": "Detalhe completo (custo extra)", "type": "boolean", "description": "Abre cada anúncio para somar IPTU, todas as características, idade, telefone do anunciante, endereço, descrição completa e data de publicação. É mais lento e tem custo adicional por anúncio.", "default": false }, "monitorMode": { "title": "Modo monitoramento", "type": "boolean", "description": "Lembra os anúncios entre execuções e retorna só os novos e os que mudaram de preço, com o preço anterior e o % de mudança. A primeira execução retorna tudo.", "default": false }, "monitorName": { "title": "Nome do monitoramento", "type": "string", "description": "Opcional. Use o mesmo nome para compartilhar a memória entre configurações. Vazio = identificado pelos filtros." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "O portal exige IP residencial do Brasil. Deixe como está.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } } }, "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 } } } } } } } } } }