{
"openapi": "3.0.1",
"info": {
"title": "Zapimoveis Scraper | Real Estate Listings and Prices",
"description": "Zapimoveis scraper for ZAP Imóveis, Brazil's property portal: listings for sale, for rent or new developments from a neighborhood, a Zap link or a listing id. 56 fields per listing, 20 listings in 2 seconds: price, condo fee, IPTU, price per square meter, address, coordinates, agency phones, CRECI.",
"version": "1.0",
"x-build-id": "Ryuc0verih30iYVtz"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/silentflow~zapimoveis-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-silentflow-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/silentflow~zapimoveis-scraper/runs": {
"post": {
"operationId": "runs-sync-silentflow-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/silentflow~zapimoveis-scraper/run-sync": {
"post": {
"operationId": "run-sync-silentflow-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",
"properties": {
"searches": {
"title": "📍 Places",
"type": "array",
"description": "Neighborhoods, cities, zones or streets, typed as on Zap, one per line: Pinheiros, São Paulo, Copacabana, Belo Horizonte, Avenida Paulista. Add the city after a comma when a name exists in several cities. A state code (SP, RJ) or a state name (Minas Gerais) searches the whole state; São Paulo and Rio de Janeiro mean the cities. The deal and filters below apply to every place.",
"items": {
"type": "string"
}
},
"startUrls": {
"title": "🔗 Zap links",
"type": "array",
"description": "Search pages or listing pages copied from zapimoveis.com.br: https://www.zapimoveis.com.br/venda/apartamentos/sp+sao-paulo+zona-oeste+pinheiros/, https://www.zapimoveis.com.br/aluguel/imoveis/rj+rio-de-janeiro+zona-sul+copacabana/?quartos=2, https://www.zapimoveis.com.br/imovel/venda-apartamento-...-id-2916693773/. A search link keeps its own deal, type, rooms, price and order, exactly as you set them on the site.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"listingIds": {
"title": "🆔 Listing IDs",
"type": "array",
"description": "Zap listing ids, the number after -id- in a listing link: 2916693773. Each id gives one row, for sale or for rent. Handy to refresh the listings you already follow.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "🔢 Max listings",
"minimum": 1,
"type": "integer",
"description": "How many listings to save in total, across every place and link. A busy neighborhood holds thousands of listings; set the number you actually need.",
"default": 100
},
"business": {
"title": "🏷️ Deal",
"enum": [
"SALE",
"RENTAL",
"DEVELOPMENT"
],
"type": "string",
"description": "Listings for sale, for rent, or new developments (lançamentos, sold by their developer).",
"default": "SALE"
},
"propertyType": {
"title": "🏢 Property type",
"enum": [
"any",
"apartment",
"house",
"condominium_house",
"penthouse",
"studio",
"kitnet",
"flat",
"loft",
"two_story_house",
"village_house",
"land",
"farm",
"office",
"store",
"commercial_house",
"floor",
"commercial_building",
"commercial_land",
"warehouse",
"hotel",
"parking"
],
"type": "string",
"description": "One type of property, the way Zap sorts them, or every type.",
"default": "any"
},
"minPrice": {
"title": "💰 Min price (BRL)",
"minimum": 0,
"type": "integer",
"description": "Lowest price in reais: the sale price, or the monthly rent for rentals. Leave empty for no minimum."
},
"maxPrice": {
"title": "💰 Max price (BRL)",
"minimum": 0,
"type": "integer",
"description": "Highest price in reais: 1500000 for sales, 5000 for a monthly rent. Leave empty for no maximum."
},
"minBedrooms": {
"title": "🛏️ Min bedrooms",
"minimum": 0,
"type": "integer",
"description": "Keep listings with at least this many bedrooms (quartos). Listings that do not give their bedrooms are left out when this is set."
},
"sortBy": {
"title": "🔽 Sort by",
"enum": [
"relevance",
"newest",
"lowest_price",
"highest_price",
"largest_area"
],
"type": "string",
"description": "The order Zap returns listings in. Newest is the one to schedule for a daily feed of new listings.",
"default": "relevance"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}