{ "openapi": "3.0.1", "info": { "title": "ZAP Imóveis BR $1💰 URL | Filters | Property Scraper", "description": "From $1/1K. Scrape Zap Imóveis property listings across sale, rental, and new developments. Search by city with filters or paste URLs with pagination. Extract 80+ fields including price, fees, GPS, address, agency contact, CRECI, amenities, POIs, H3 hash, scores, and media.", "version": "1.0", "x-build-id": "budHoL2DUdGRpS5rk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~zapimoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-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/abotapi~zapimoveis-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-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/abotapi~zapimoveis-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-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", "required": [ "mode" ], "properties": { "mode": { "title": "Search Mode", "enum": [ "search", "url" ], "type": "string", "description": "Pick how to find listings. 'search' uses the filter fields below. 'url' takes the listing URLs you paste and walks pagination forward.", "default": "search" }, "locations": { "title": "Locations", "type": "array", "description": "Cities to search. Free-form (e.g. 'Sao Paulo, SP', 'Rio de Janeiro', 'Curitiba PR'). Diacritics optional. Each entry resolves to its canonical ZAP location ID via the public autocomplete API.", "items": { "type": "string" } }, "businessType": { "title": "Sale or Rental", "enum": [ "SALE", "RENTAL" ], "type": "string", "description": "SALE = for sale, RENTAL = for rent.", "default": "SALE" }, "listingType": { "title": "Listing Type", "enum": [ "USED", "DEVELOPMENT" ], "type": "string", "description": "USED = existing properties on the resale market. DEVELOPMENT = new construction launches (lancamentos).", "default": "USED" }, "propertyType": { "title": "Property Type", "enum": [ "ANY", "APARTMENT", "HOME", "PENTHOUSE", "STUDIO", "ALLOTMENT_LAND", "FARM", "OFFICE", "COMMERCIAL_BUILDING", "SHED_DEPOSIT_WAREHOUSE", "BUSINESS" ], "type": "string", "description": "Filter by property category. ANY returns all types.", "default": "ANY" }, "minPrice": { "title": "Min Price (BRL)", "minimum": 0, "type": "integer", "description": "Minimum price in Brazilian Reais. Leave empty for no minimum." }, "maxPrice": { "title": "Max Price (BRL)", "minimum": 0, "type": "integer", "description": "Maximum price in Brazilian Reais. Leave empty for no maximum." }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms." }, "minParkingSpaces": { "title": "Min Parking Spaces", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum parking spots." }, "minUsableArea": { "title": "Min Usable Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum usable floor area in square meters." }, "maxUsableArea": { "title": "Max Usable Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum usable floor area in square meters." }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "price-asc", "price-desc", "newest", "area-desc" ], "type": "string", "description": "Result ordering. 'relevance' = ZAP default (sponsored + ranked); 'price-asc' / 'price-desc' = primary price; 'newest' = most recently updated first; 'area-desc' = largest usable area first.", "default": "relevance" }, "urls": { "title": "Listing URLs", "type": "array", "description": "ZAP search-page URLs to walk (URL mode only). Multi-URL supported. Filter fields above are ignored. Pagination starts at the page in the URL and walks forward. Examples: 'https://www.zapimoveis.com.br/aluguel/imoveis/sp+sao-paulo/', 'https://www.zapimoveis.com.br/venda/apartamentos/rj+rio-de-janeiro/?precoMaximo=500000&quartos=2'.", "items": { "type": "string" } }, "maxPages": { "title": "Max Pages Per Search", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum pages of results to walk per search or URL. Each page returns up to 24 listings. Default is set generously high so maxListings is the effective stopping condition.", "default": 200 }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Total maximum number of listings to return across all searches. Set 0 for unlimited (subject to maxPages).", "default": 20 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Apify Residential proxy is strongly recommended. The site rejects datacenter ranges; without residential, runs return zero items. Default country = BR. Free-tier accounts do not include residential, see the README for the upgrade path." } } }, "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 } } } } } } } } } }