{ "openapi": "3.0.1", "info": { "title": "Belgium Real Estate Scraper ($0.80/1K)", "description": "Search Zimmo, Immoweb and Immovlan at once for homes in Belgium (te koop, te huur). One search, one dataset: merged, deduplicated on postcode and house number, newest first. Optional full details and price history. Residential proxy included. Export to JSON, CSV or Excel.", "version": "0.0", "x-build-id": "AQen2BWeJCcBgcEni" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/carabain-digital~belgium-real-estate/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-carabain-digital-belgium-real-estate", "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/carabain-digital~belgium-real-estate/runs": { "post": { "operationId": "runs-sync-carabain-digital-belgium-real-estate", "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/carabain-digital~belgium-real-estate/run-sync": { "post": { "operationId": "run-sync-carabain-digital-belgium-real-estate", "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": { "location": { "title": "Location", "type": "string", "description": "Belgian city, municipality or postcode, sent to all selected sites. Several places separated by commas run as separate searches. Example: `Gent`, `Antwerpen, Gent` or `9000`. Leave empty for all of Belgium." }, "listing_type": { "title": "Listing type", "enum": [ "sale", "rent" ], "type": "string", "description": "Search homes `rent` or `sale`. Example: `rent`.", "default": "sale" }, "min_price": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Lowest asking price in euro (rent per month for rentals). Example: `1000` (rent) or `250000` (sale)." }, "max_price": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Highest asking price in euro (rent per month for rentals). Example: `2000` (rent) or `500000` (sale)." }, "property_type": { "title": "Property type", "enum": [ "any", "house", "apartment", "land", "commercial", "parking", "room" ], "type": "string", "description": "Only this type of property. Example: `apartment`. `any` returns every type. A site that does not know the type (only Zimmo has `room`) is skipped.", "default": "any" }, "min_rooms": { "title": "Min rooms", "minimum": 1, "type": "integer", "description": "Only homes with at least this many bedrooms (Zimmo, Immoweb and Immovlan all count bedrooms). Example: `2`." }, "min_living_area_m2": { "title": "Min living area (m2)", "minimum": 1, "type": "integer", "description": "Only homes with at least this living area in square metres. Example: `60`." }, "sites": { "title": "Sites", "type": "array", "description": "Which sites to search. Default: all of them. Example: `[\"zimmo\", \"immoweb\", \"immovlan\"]`.", "items": { "type": "string", "enum": [ "zimmo", "immoweb", "immovlan" ], "enumTitles": [ "Zimmo (BE)", "Immoweb (BE)", "Immovlan (BE)" ] }, "default": [ "zimmo", "immoweb", "immovlan" ] }, "limit": { "title": "Max listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap on the merged dataset, newest first. Example: `100`.", "default": 100 }, "limit_per_site": { "title": "Max listings per site", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Optional cap per site, to keep the mix balanced and browser sites short. Default: Max listings. Example: `25`." }, "includeDetails": { "title": "Full details (paid add-on)", "type": "boolean", "description": "Also open each listing's detail page on Immoweb and Immovlan: description, coordinates, area, agent and more. Adds $2.00 per 1,000 listings that were actually enriched. Zimmo already has everything in the search and is never charged. Runs take longer.", "default": false }, "trackHistory": { "title": "Price history (paid add-on)", "type": "boolean", "description": "Keep a price and status history per listing in a named storage in your own account and add `first_seen_at`, `previous_price`, `price_change`, `price_change_pct`, `status_changed` and `price_history` to every listing you have scraped before. The history store is shared with our single-site real-estate Actors. Adds $1.00 per 1,000 listings that already had history (the first run only starts the series). Do not run two runs on the same store at once.", "default": false }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Name of the key-value store that holds the history (a-z, 0-9 and dashes). Use the same name in all our real-estate Actors to share one history. Example: `realestate-history`.", "default": "realestate-history" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Keep Apify RESIDENTIAL (the default). The Actor sets the exit country to Belgium for Immoweb and uses no proxy for Zimmo and Immovlan.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "BE" } } } }, "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 } } } } } } } } } }