{ "openapi": "3.0.1", "info": { "title": "ZAP Imoveis Brazil Real Estate Scraper | Property Listings API", "description": "Scrape ZAP Imoveis property listings for sale and rent across Brazil. Extract price, condo fee, IPTU, area, bedrooms, bathrooms, parking, coordinates, amenities, advertiser phone, WhatsApp and CRECI license. Filter by city, price, area and beds. Export imoveis data to JSON, CSV or Excel.", "version": "0.2", "x-build-id": "AzLTcHcxnqohPpQa1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~zap-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-zap-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/scrapers_lat~zap-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-zap-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/scrapers_lat~zap-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-zap-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": { "startUrl": { "title": "Search URL", "type": "string", "description": "A full ZAP Imóveis search results URL, for example https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/ or any filtered search. Every filter encoded in the URL (operation, property type, location, price, area, bedrooms) is respected automatically." }, "startUrls": { "title": "Search URLs (batch)", "type": "array", "description": "Optional list of ZAP Imóveis search URLs to scrape in one run. Accepts plain strings or {\"url\": \"...\"} objects.", "items": { "type": "string" } }, "city": { "title": "City", "type": "string", "description": "Optional. City name to build a search URL when no URL is given (used together with State), for example Sao Paulo." }, "state": { "title": "State (UF)", "type": "string", "description": "Optional. Two-letter Brazilian state code to pair with City, for example SP, RJ, MG." }, "operation": { "title": "Operation", "enum": [ "venda", "aluguel" ], "type": "string", "description": "Optional operation filter and URL builder value." }, "propertyType": { "title": "Property type", "type": "string", "description": "Optional property type filter, for example APARTMENT, HOME, LAND, COMMERCIAL, FARM." }, "listingType": { "title": "Listing condition", "type": "string", "description": "Optional. Filter by USED or DEVELOPMENT (new development)." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional minimum price (listing currency, BRL)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional maximum price (listing currency, BRL)." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Optional minimum number of bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Optional maximum number of bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Optional minimum number of bathrooms." }, "minParking": { "title": "Min parking spaces", "minimum": 0, "type": "integer", "description": "Optional minimum number of parking spaces." }, "minAreaM2": { "title": "Min area (m2)", "minimum": 0, "type": "integer", "description": "Optional minimum usable area in square meters." }, "maxAreaM2": { "title": "Max area (m2)", "minimum": 0, "type": "integer", "description": "Optional maximum usable area in square meters." }, "withDetails": { "title": "Fetch listing details", "type": "boolean", "description": "When enabled, each record is enriched with the full description, complete image gallery, amenities, advertiser contact details (name, phones, WhatsApp, CRECI license, tier). When disabled, only the core listing fields are returned. Enrichment applies to paid Apify plans.", "default": true }, "maxListings": { "title": "Max listings", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of listings to collect. Leave blank for all. Free Apify plans are capped at 10 per run." } } }, "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 } } } } } } } } } }