{ "openapi": "3.0.1", "info": { "title": "Immoweb.be Belgium Property Scraper", "description": "Immoweb scraper & API for Belgian real estate: search property for sale and rent and export address, price, bedrooms, area, EPC energy, property type, agent, photos and coordinates. Belgium property market data and real-estate lead generation — fast, no login.", "version": "1.0", "x-build-id": "yfSgwZVBSrT8Gq9J4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~immoweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-immoweb-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/haketa~immoweb-scraper/runs": { "post": { "operationId": "runs-sync-haketa-immoweb-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/haketa~immoweb-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-immoweb-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": { "propertyType": { "title": "Property Type", "enum": [ "house-and-apartment", "house", "apartment", "land", "office", "commercial", "garage" ], "type": "string", "description": "Which kind of property to collect. Choose from the menu.", "default": "house-and-apartment" }, "transactionType": { "title": "For Sale or For Rent", "enum": [ "for-sale", "for-rent" ], "type": "string", "description": "Collect properties for sale or properties for rent.", "default": "for-sale" }, "location": { "title": "Location", "enum": [ "", "brussels/district", "antwerp/municipality", "ghent/municipality", "bruges/municipality", "leuven/municipality", "mechelen/municipality", "aalst/municipality", "kortrijk/municipality", "hasselt/municipality", "ostend/municipality", "liege/municipality", "namur/municipality", "charleroi/municipality", "mons/municipality", "tournai/municipality", "wavre/municipality", "antwerp/province", "east-flanders/province", "west-flanders/province", "flemish-brabant/province", "limburg/province", "liege/province", "hainaut/province", "namur/province", "walloon-brabant/province", "luxembourg/province" ], "type": "string", "description": "Pick a city, province or district. Choose 'All of Belgium' to get a nationwide mix of listings.", "default": "" }, "language": { "title": "Language", "enum": [ "en", "fr", "nl" ], "type": "string", "description": "Site language for listing descriptions and text.", "default": "en" }, "minPrice": { "title": "Min Price (€)", "minimum": 0, "type": "integer", "description": "Only keep listings at or above this price in EUR. Leave at 0 for no minimum.", "default": 0 }, "maxPrice": { "title": "Max Price (€)", "minimum": 0, "type": "integer", "description": "Only keep listings at or below this price in EUR. Leave at 0 for no maximum.", "default": 0 }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "type": "integer", "description": "Only keep listings with at least this many bedrooms. Leave at 0 for no minimum.", "default": 0 }, "scrapeDetails": { "title": "Include Full Details (slower)", "type": "boolean", "description": "Also open each listing page to collect extra fields: EPC energy score, full description, heating type, build year, flood zone and agency contact. Slower but more complete.", "default": false }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Stop after collecting this many listings. Set 0 for unlimited.", "default": 0 }, "maxPages": { "title": "Max Pages", "minimum": 0, "type": "integer", "description": "Maximum number of search result pages to open (about 30 listings per page). Set 0 for unlimited.", "default": 3 }, "startUrls": { "title": "Start URLs (advanced)", "type": "array", "description": "Optional. Paste one or more Immoweb.be search or listing URLs to scrape them exactly. When set, these override the menu filters above. Most users can leave this empty.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "locationCustom": { "title": "Custom Location Slug (advanced)", "type": "string", "description": "Optional. For a location that is not in the menu, paste the Immoweb location path here, e.g. 'knokke-heist/municipality'. Only used when the Location menu is set to 'All of Belgium'." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. A Belgian residential proxy is recommended for reliable results." }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Pause between page loads in milliseconds. Higher values are gentler on the site.", "default": 2000 } } }, "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 } } }, "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 } } } } } } } } } }