{ "openapi": "3.0.1", "info": { "title": "ZAP Imóveis Listings Scraper", "description": "ZAP Imóveis Listings Scraper SD - ZAP Imóveis Listings Scraper is a Brazil real estate data tool that extracts public ZAP Imóveis sale and rental listings: price, condo fee, IPTU, area, rooms, address, GPS, photos, amenities and advertiser.", "version": "1.0", "x-build-id": "KbTX7p1XukxWEorLk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~zap-imoveis-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-zap-imoveis-listings-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/neuro-scraper~zap-imoveis-listings-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-zap-imoveis-listings-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/neuro-scraper~zap-imoveis-listings-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-zap-imoveis-listings-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": { "locations": { "title": "Locations (city, state)", "type": "array", "description": "Cities to search, one per line, as 'City, UF' (e.g. São Paulo, SP / Rio de Janeiro, RJ / Belo Horizonte, MG), a state code (SP), or the location part of a ZAP URL for a zone or neighbourhood (e.g. sp+sao-paulo+zona-sul+moema). Each location is searched with the filters below.", "items": { "type": "string" } }, "startUrls": { "title": "ZAP search or listing URLs", "type": "array", "description": "Search pages copied from zapimoveis.com.br (every filter in the URL is kept), e.g. https://www.zapimoveis.com.br/aluguel/imoveis/rj+rio-de-janeiro/?quartos=3 , or single listing pages (https://www.zapimoveis.com.br/imovel/...-id-2885561260/) - one row each.", "items": { "type": "string" } }, "business": { "title": "Transaction", "enum": [ "SALE", "RENTAL" ], "type": "string", "description": "Sale or rental listings (used for Locations; start URLs keep their own).", "default": "SALE" }, "unitTypes": { "title": "Property types", "type": "array", "description": "ZAP's property-type filter; leave empty for every type. Several types can be combined.", "items": { "type": "string", "enum": [ "APARTMENT", "HOME", "TWO_STORY_HOUSE", "CONDOMINIUM", "VILLAGE_HOUSE", "PENTHOUSE", "FLAT", "KITNET", "STUDIO", "LOFT", "RESIDENTIAL_BUILDING", "RESIDENTIAL_ALLOTMENT_LAND", "FARM", "COUNTRY_HOUSE", "OFFICE", "BUSINESS", "COMMERCIAL_PROPERTY", "COMMERCIAL_BUILDING", "COMMERCIAL_ALLOTMENT_LAND", "SHED_DEPOSIT_WAREHOUSE", "CLINIC", "HOTEL", "FLOOR", "PARKING_SPACE" ], "enumTitles": [ "Apartment (apartamento)", "House (casa)", "Two-story house (sobrado)", "House in gated community (casa de condomínio)", "Village house (casa de vila)", "Penthouse (cobertura)", "Flat", "Kitnet", "Studio", "Loft", "Residential building", "Residential land / lot", "Farm (granja)", "Country house (chácara)", "Office (sala comercial)", "Business premises (ponto comercial)", "Commercial property", "Commercial building", "Commercial land / lot", "Warehouse / shed (galpão)", "Clinic (consultório)", "Hotel / motel / inn", "Corporate floor / store", "Parking space (garagem)" ] }, "default": [] }, "minPrice": { "title": "Minimum price (BRL)", "minimum": 0, "type": "integer", "description": "ZAP's price filter, lower bound in reais (0 = none), e.g. 300000. For rentals it is the monthly rent.", "default": 0 }, "maxPrice": { "title": "Maximum price (BRL)", "minimum": 0, "type": "integer", "description": "ZAP's price filter, upper bound in reais (0 = none), e.g. 900000.", "default": 0 }, "minArea": { "title": "Minimum area (m²)", "minimum": 0, "type": "integer", "description": "ZAP's usable-area filter, lower bound in m² (0 = none), e.g. 60.", "default": 0 }, "maxArea": { "title": "Maximum area (m²)", "minimum": 0, "type": "integer", "description": "ZAP's usable-area filter, upper bound in m² (0 = none), e.g. 150.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 4, "type": "integer", "description": "At least this many bedrooms (quartos), 1-4 (4 = 4 or more); 0 = any.", "default": 0 }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 4, "type": "integer", "description": "At least this many bathrooms (banheiros), 1-4 (4 = 4 or more); 0 = any.", "default": 0 }, "minParkingSpaces": { "title": "Minimum parking spaces", "minimum": 0, "maximum": 4, "type": "integer", "description": "At least this many parking spaces (vagas), 1-4 (4 = 4 or more); 0 = any.", "default": 0 }, "sort": { "title": "Sort by", "enum": [ "MOST_RELEVANT", "MOST_RECENT", "LOWEST_PRICE", "BIGGEST_PRICE", "BIGGEST_AREA" ], "type": "string", "description": "ZAP's own sort order (used for Locations; start URLs keep their own 'ordem'). The first slots of a page can be paid highlighted listings.", "default": "MOST_RELEVANT" }, "splitBySort": { "title": "Go past the site's page limit (re-run with other sort orders)", "type": "boolean", "description": "ZAP serves at most about 50-99 pages (1,500-3,000 listings) per search. When a search ends there before Max listings, it is repeated with the other sort orders and duplicates are removed.", "default": false }, "scrapeDetails": { "title": "Open each listing page (full description, created / updated dates, videos)", "type": "boolean", "description": "One extra request per listing for createdAt, updatedAt, the full description (search pages carry it only for some cards), videos, virtual tour link and the advertiser's listing count.", "default": false }, "maxItems": { "title": "Max listings per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Listings per location / start URL. The Actor follows ZAP's own pages (pagina=2, 3 ... 30 per page) until this number, the last page or the site's page limit.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Keep RESIDENTIAL in Brazil: ZAP's firewall blocks most non-Brazilian IPs (measured). An Apify proxy without a country gets BR added. A blocked request is retried on a new IP.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BR" } } } }, "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 } } } } } } } } } }