{
"openapi": "3.0.1",
"info": {
"title": "ZAP Imóveis Property Listings Scraper",
"description": "Scrape ZAP Imóveis (Brazil) property listings for sale or rent by city or neighborhood, or from any search link: price, condo fee, IPTU, area, bedrooms, bathrooms, parking, amenities, address, coordinates, photos and agency. Type, bedroom, price and area filters, sort. No browser, pay per listing.",
"version": "1.0",
"x-build-id": "s06CPElSeQbr64ZPL"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/brii3343~zapimoveis-property-listings-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-brii3343-zapimoveis-property-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/brii3343~zapimoveis-property-listings-scraper/runs": {
"post": {
"operationId": "runs-sync-brii3343-zapimoveis-property-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/brii3343~zapimoveis-property-listings-scraper/run-sync": {
"post": {
"operationId": "run-sync-brii3343-zapimoveis-property-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": {
"searchQueries": {
"title": "Locations (city or neighborhood)",
"type": "array",
"description": "Where to search, one location per line, as you would type it in the ZAP Imóveis search bar: a city (Curitiba), a neighborhood with its city (Copacabana, Rio de Janeiro, Pinheiros, São Paulo) or a zone (Zona Sul, São Paulo). Each location is one search with the filters below, read page by page.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "ZAP Imóveis search URLs",
"type": "array",
"description": "ZAP Imóveis search links with any filter you set on the site (location, type, bedrooms, price, area, sort): search on zapimoveis.com.br, then copy the address bar, for example https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo/ or https://www.zapimoveis.com.br/aluguel/imoveis/rj+rio-de-janeiro+zona-sul+copacabana/. The filters below do not change these links.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"transaction": {
"title": "Buy or rent",
"enum": [
"sale",
"rent",
"new_developments"
],
"type": "string",
"description": "For locations: properties for sale, for rent, or new developments (lançamentos).",
"default": "sale"
},
"propertyTypes": {
"title": "Property types",
"type": "array",
"description": "Only these property types (for locations). Empty = all types.",
"items": {
"type": "string",
"enum": [
"APARTMENT",
"HOME",
"CONDOMINIUM",
"TWO_STORY_HOUSE",
"VILLAGE_HOUSE",
"PENTHOUSE",
"FLAT",
"STUDIO",
"KITNET",
"LOFT",
"RESIDENTIAL_ALLOTMENT_LAND",
"FARM",
"OFFICE",
"BUSINESS",
"COMMERCIAL_PROPERTY",
"COMMERCIAL_BUILDING",
"FLOOR",
"COMMERCIAL_ALLOTMENT_LAND",
"SHED_DEPOSIT_WAREHOUSE",
"HOTEL",
"PARKING_SPACE"
],
"enumTitles": [
"Apartamento",
"Casa",
"Casa de condomínio",
"Sobrado",
"Casa de vila",
"Cobertura",
"Flat",
"Studio",
"Kitnet",
"Loft",
"Terreno / lote",
"Fazenda / sítio / chácara",
"Sala / conjunto comercial",
"Loja / ponto comercial",
"Casa comercial",
"Prédio inteiro",
"Andar / laje corporativa",
"Terreno comercial",
"Galpão / depósito",
"Hotel / pousada",
"Garagem"
]
}
},
"bedrooms": {
"title": "Bedrooms",
"type": "array",
"description": "Only properties with these numbers of bedrooms (for locations), as on ZAP Imóveis: 4 means 4 or more. Empty = any.",
"items": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"enumTitles": [
"1",
"2",
"3",
"4+"
]
}
},
"minPrice": {
"title": "Min price (BRL)",
"minimum": 0,
"type": "integer",
"description": "Minimum sale price, or monthly rent for rentals, in reais (for locations)."
},
"maxPrice": {
"title": "Max price (BRL)",
"minimum": 0,
"type": "integer",
"description": "Maximum sale price, or monthly rent for rentals, in reais (for locations)."
},
"minArea": {
"title": "Min area (m²)",
"minimum": 0,
"type": "integer",
"description": "Minimum usable area in square meters (for locations)."
},
"maxArea": {
"title": "Max area (m²)",
"minimum": 0,
"type": "integer",
"description": "Maximum usable area in square meters (for locations)."
},
"sortBy": {
"title": "Sort by",
"enum": [
"relevance",
"newest",
"price_low",
"price_high",
"biggest_area"
],
"type": "string",
"description": "Order of the results for locations, as on ZAP Imóveis.",
"default": "relevance"
},
"maxItemsPerSource": {
"title": "Max listings per location or URL",
"minimum": 0,
"type": "integer",
"description": "Listings to save for each location and each URL. 0 = everything the search shows (ZAP Imóveis shows at most about 1,500 listings per search: split big cities by neighborhood, type or price).",
"default": 100
},
"maxItems": {
"title": "Max listings in total",
"minimum": 0,
"type": "integer",
"description": "Stop after this many listings in the whole run. 0 = no limit.",
"default": 0
},
"proxyConfiguration": {
"title": "Proxy",
"type": "object",
"description": "Not needed: the scraper connects directly and switches to Apify Proxy (residential, Brazil) by itself only when ZAP Imóveis blocks it. Set a proxy here only to force one.",
"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
}
}
}
}
}
}
}
}
}
}