{ "openapi": "3.0.1", "info": { "title": "ZAP Imóveis Scraper — Brazil Sale & Rent", "description": "Extract ZAP Imóveis listings for sale or rent across Brazil. Get price in BRL, area, bedrooms, neighborhood, condo fee, and the agency. Search URL or city filters, plus a monitor for new listings.", "version": "0.1", "x-build-id": "ceWX9xx395vaoIHNS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawloop~zap-imoveis-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawloop-zap-imoveis-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/crawloop~zap-imoveis-scraper/runs": { "post": { "operationId": "runs-sync-crawloop-zap-imoveis-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/crawloop~zap-imoveis-scraper/run-sync": { "post": { "operationId": "run-sync-crawloop-zap-imoveis-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "ZAP Imóveis search pages or a single listing URL. When this list is set, the builder fields below are ignored.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "transaction": { "title": "Sale or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Used only when Start URLs is empty.", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "apartments", "houses", "penthouses", "studios", "land", "commercial", "offices", "farms", "all" ], "type": "string", "description": "Used only when Start URLs is empty.", "default": "apartments" }, "state": { "title": "State", "type": "string", "description": "Two-letter state code, for example SP or RJ. Used with City when Start URLs is empty.", "default": "SP" }, "city": { "title": "City", "type": "string", "description": "City name, for example Sao Paulo. Used when Start URLs is empty.", "default": "Sao Paulo" }, "neighborhood": { "title": "Neighborhood", "type": "string", "description": "Optional neighborhood, for example Pinheiros." }, "priceMin": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "Minimum price in Brazilian reais." }, "priceMax": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "Maximum price in Brazilian reais." }, "bedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Minimum bedroom count." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum dataset rows for this run.", "default": 30 }, "onlyPrivate": { "title": "Private sellers only", "type": "boolean", "description": "Keep rows that are not marked as a real-estate agency.", "default": false }, "monitorMode": { "title": "Monitor mode", "type": "boolean", "description": "Remember the newest listing and, on the next run, save only listings created after it. An empty tick saves nothing.", "default": false }, "monitorStateStore": { "title": "Monitor state store", "type": "string", "description": "Named key-value store that keeps the monitor cursor across scheduled runs.", "default": "zap-imoveis-monitor" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave proxy off unless the run is blocked. If it is blocked, enable Apify Proxy and try datacenter before residential.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }