{ "openapi": "3.0.1", "info": { "title": "Zap Imoveis Brasil", "description": "Extrai anuncios de imoveis do Zap Imoveis Brasil a partir de buscas por localidade ou URLs diretas, com paginacao, estados auditaveis e custo por resultado.", "version": "0.1", "x-build-id": "Zps7eB7zDE1KQxdGh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pmodinger~zap-imoveis-brasil/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pmodinger-zap-imoveis-brasil", "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/pmodinger~zap-imoveis-brasil/runs": { "post": { "operationId": "runs-sync-pmodinger-zap-imoveis-brasil", "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/pmodinger~zap-imoveis-brasil/run-sync": { "post": { "operationId": "run-sync-pmodinger-zap-imoveis-brasil", "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": [ "businessType", "propertyType", "locations" ], "properties": { "startUrls": { "title": "URLs de busca do Zap Imoveis", "type": "array", "description": "Opcional. Use URLs diretas do Zap Imoveis quando quiser controlar filtros da busca. Se informado, substitui a geracao por localidade.", "items": { "type": "string" } }, "businessType": { "title": "Tipo de negocio", "enum": [ "venda", "aluguel" ], "type": "string", "description": "Tipo de busca no Zap Imoveis.", "default": "venda" }, "propertyType": { "title": "Tipo de imovel", "enum": [ "imoveis", "apartamentos", "casas", "casas-de-condominio", "sobrados", "coberturas", "kitnets", "studios", "lofts", "terrenos-lotes-condominios", "fazendas-sitios-chacaras", "galpoes-depositos-armazens", "salas-comerciais", "lojas-saloes", "conjuntos-comerciais", "predios-comerciais", "pontos-comerciais" ], "type": "string", "description": "Tipo de imovel usado para gerar a URL de busca do Zap Imoveis.", "default": "imoveis" }, "locations": { "title": "Localidades", "type": "array", "description": "Aceita slugs de localidade do Zap Imoveis ou texto comum. Exemplos: sp+sao-paulo, rj+rio-de-janeiro, Sao Paulo, Sao Paulo, SP.", "items": { "type": "string" }, "default": [ "sp+sao-paulo" ] }, "keywords": { "title": "Palavras-chave", "type": "array", "description": "Opcional. Adiciona o parametro q na URL gerada. Deixe vazio para buscar todos os anuncios da localidade.", "items": { "type": "string" } }, "maxItemsPerUrl": { "title": "Maximo de anuncios por URL", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Limite total por URL de busca. O usuario paga apenas por anuncios entregues com status success.", "default": 100 }, "maxPagesPerUrl": { "title": "Maximo de paginas por URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Quantidade maxima de paginas a percorrer por URL.", "default": 4 }, "startPage": { "title": "Pagina inicial", "minimum": 1, "maximum": 500, "type": "integer", "description": "Numero da primeira pagina da busca.", "default": 1 }, "requestTimeoutSecs": { "title": "Timeout por pagina", "minimum": 15, "maximum": 180, "type": "integer", "description": "Timeout em segundos para cada pagina.", "default": 30 }, "retries": { "title": "Tentativas por pagina", "minimum": 1, "maximum": 6, "type": "integer", "description": "Numero de tentativas por pagina em erros transitorios.", "default": 2 }, "ignoreUrlFailures": { "title": "Ignorar falhas por URL", "type": "boolean", "description": "Se ativado, uma URL bloqueada ou com falha nao interrompe a execucao quando outras URLs ainda podem retornar dados.", "default": true }, "proxyConfig": { "title": "Configuracao de proxy", "type": "object", "description": "Use proxy da Apify se a origem bloquear requisicoes diretas.", "default": { "useApifyProxy": false } }, "failOnNoResults": { "title": "Falhar quando nenhuma URL retornar resultado", "type": "boolean", "description": "Se ativado, a execucao falha quando todas as URLs retornarem no_results.", "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 } } }, "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 } } } } } } } } } }