{ "openapi": "3.0.1", "info": { "title": "ZAP Imóveis Scraper - Brazil Real Estate Data", "description": "Scrape ZAP Imoveis (Brazil) property listings, sale or rental. One row per property: price, condo fee, IPTU, area, bedrooms, bathrooms, parking, amenities, full address with lat/lon, advertiser and photos. Search by city or paste ZAP URLs. JSON/CSV out.", "version": "0.1", "x-build-id": "C4c3Ppzm4KZzq2AqW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~zapimoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-zapimoveis-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/memo23~zapimoveis-scraper/runs": { "post": { "operationId": "runs-sync-memo23-zapimoveis-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/memo23~zapimoveis-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-zapimoveis-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": { "searchLocations": { "title": "Locations to search", "type": "array", "description": "City or neighbourhood names, e.g. `São Paulo`, `Rio de Janeiro`, `Copacabana`, `Belo Horizonte`. Each is resolved through ZAP's own location autocomplete, then combined with the Business / Property types / price filters below.", "items": { "type": "string" } }, "business": { "title": "Business", "enum": [ "SALE", "RENTAL" ], "type": "string", "description": "Sale (venda) or rental (aluguel) — applies to the locations above.", "default": "SALE" }, "unitTypes": { "title": "Property types", "type": "array", "description": "Filter the location searches by property type. Leave empty for all types.", "items": { "type": "string", "enum": [ "APARTMENT", "HOME", "CONDOMINIUM", "ALLOTMENT_LAND", "COMMERCIAL_PROPERTY", "FARM" ], "enumTitles": [ "Apartment", "House", "House in condominium", "Land / lot", "Commercial", "Farm / country" ] }, "default": [] }, "minPrice": { "title": "Min price (BRL)", "minimum": 0, "type": "integer", "description": "Minimum price in reais for the location searches." }, "maxPrice": { "title": "Max price (BRL)", "minimum": 0, "type": "integer", "description": "Maximum price in reais for the location searches." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms for the location searches." }, "startUrls": { "title": "ZAP URLs (search or property)", "type": "array", "description": "Paste ZAP Imoveis URLs — search-result pages (`https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/`) and/or property-detail pages (`https://www.zapimoveis.com.br/imovel/...-id-2878107686/`). Auto-classified.", "items": { "type": "string" } }, "scrapeDetails": { "title": "Scrape property detail pages", "type": "boolean", "description": "For pasted property-detail URLs, parse the page's structured data. Search results already return ~40 fields per property from the API, so you rarely need this. Default off.", "default": false }, "maxItems": { "title": "Max results (whole run)", "minimum": 1, "type": "integer", "description": "Hard cap on rows across the entire run. Each row is one paid `property` event. Default 1000. Free-tier users are additionally capped at 100.", "default": 1000 }, "maxItemsPerSearch": { "title": "Max properties per location", "minimum": 1, "type": "integer", "description": "Cap per location / search URL. The API returns 100 properties per page. Default 1000.", "default": 1000 }, "maxConcurrency": { "title": "Max parallel requests", "minimum": 1, "maximum": 15, "type": "integer", "description": "Parallel HTTP requests. Default 6.", "default": 6 }, "maxRequestRetries": { "title": "Max request retries", "minimum": 0, "type": "integer", "description": "Per-request retry budget on 403 / 429 / 5xx and network errors. Each retry rotates to a fresh Brazil residential IP. Default 12.", "default": 12 }, "proxy": { "title": "Proxy configuration (optional override)", "type": "object", "description": "Leave empty — the actor already routes all traffic through its own built-in Brazil residential proxy at no extra cost to you. Only set this if you want to use your own proxies (must be Brazil IPs)." }, "customProxyUrls": { "title": "Custom proxy URLs (advanced)", "type": "array", "description": "Optional — bring your own HTTP proxy (e.g. `http://user:pass@host:port`). When set, these are used instead of Apify Proxy on any plan; the scraper rotates the session per request. Must be Brazil IPs that work from Apify's cloud egress — ZAP returns 403 to non-Brazil addresses.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }