{ "openapi": "3.0.1", "info": { "title": "Imovelweb Scraper | Real Estate Listings", "description": "Imovelweb scraper for Brazil real estate: export property listings for sale or rent by city, keyword, URL or listing ID. 47 fields per listing: price, condo fee, IPTU, area, rooms, GPS, all photos, amenities, agency CRECI and WhatsApp. 20 listings in 27 seconds in 2026 tests. No login needed.", "version": "1.0", "x-build-id": "cCT0mhKUUDmfMrvjF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/silentflow~imovelweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-silentflow-imovelweb-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~imovelweb-scraper/runs": { "post": { "operationId": "runs-sync-silentflow-imovelweb-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~imovelweb-scraper/run-sync": { "post": { "operationId": "run-sync-silentflow-imovelweb-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": "๐Ÿ“ Cities or neighbourhoods", "type": "array", "description": "Places in Brazil to search, one per line: a city (Sรฃo Paulo, Curitiba), a neighbourhood (Pinheiros, Copacabana), a state (Minas Gerais) or a neighbourhood with its city (Centro, Belo Horizonte). Each place is searched separately with the filters below.

Leave empty to search all of Brazil, or when you paste links or listing IDs below. A large city holds hundreds of thousands of listings: use Max listings to stop where you need.", "items": { "type": "string" } }, "dealType": { "title": "๐Ÿท๏ธ Deal type", "enum": [ "sale", "rent", "vacation", "new", "auction" ], "type": "string", "description": "Listings for sale, for rent, vacation rentals, new developments (lanรงamentos) or auctions. A listing offered both for sale and for rent shows the price of the deal you pick.", "default": "sale" }, "propertyType": { "title": "๐Ÿ  Property type", "enum": [ "any", "apartment", "house", "land", "commercial", "rural" ], "type": "string", "description": "The kind of property to list. Pick All property types to get apartments, houses, land, commercial and rural properties together.", "default": "any" }, "maxItems": { "title": "๐Ÿ”ข Max listings", "minimum": 1, "type": "integer", "description": "How many listings to save in total across every place, link and ID of the run. Each listing is one row, so the run's size grows with this number. A city search returns 30 listings per results page.", "default": 100 }, "keyword": { "title": "๐Ÿ”ค Keyword", "type": "string", "description": "A word the listing must mention, as in the site's own keyword search: piscina, vista mar, mobiliado, cobertura. Write it in Portuguese, like the listings. Without a place above, it searches all of Brazil." }, "maxPrice": { "title": "๐Ÿ’ฐ Max price (BRL)", "minimum": 1, "type": "integer", "description": "Highest price in Brazilian reais, for example 800000 for a purchase or 5000 for a monthly rent. Leave empty for no limit." }, "sort": { "title": "โ†•๏ธ Sort by", "enum": [ "relevance", "newest", "price_low", "price_high", "most_viewed", "price_drop" ], "type": "string", "description": "The order listings are read in. Newest first suits daily monitoring of new supply; Price drops first surfaces listings whose price was just lowered.", "default": "relevance" }, "startUrls": { "title": "๐Ÿ”— Imovelweb links", "type": "array", "description": "Results pages with any filters (https://www.imovelweb.com.br/apartamentos-aluguel-rio-de-janeiro-rj-2-quartos.html), new developments (/lancamentos-sao-paulo-sp.html), an agency's listings (/imobiliarias/ap-imoveis_47063836-imoveis.html) or single listings (/propriedades/...-3026744234.html). A link to page 3 starts at page 3.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingIds": { "title": "๐Ÿ†” Listing IDs", "type": "array", "description": "Listing numbers to read again, for example 3026744234: the number at the end of a listing link. Handy to refresh the price and status of listings you already track. A listing taken offline returns no row.", "items": { "type": "string" } }, "includeDetails": { "title": "๐Ÿ“„ Read each listing page", "type": "boolean", "description": "On (recommended): each row also gets the IPTU, the publication date, the amenities, every photo in high resolution, the video link and the views of the last 30 days. Off: rows carry what the results pages show and the run is much faster (60 listings in 3 seconds instead of 24 in our test).", "default": true } } }, "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 } } } } } } } } } }