{ "openapi": "3.0.1", "info": { "title": "Immoweb Scraper — Belgium Property Listings & Prices, No Phones", "description": "Belgian property listings from Immoweb, for sale or to rent: price, bedrooms, living area, EPC, town and postcode, agency, and optionally the description and building details. No phones.", "version": "0.1", "x-build-id": "sFm79Te53ggZMHoYn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/highbrow_fame~immoweb-properties/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-highbrow_fame-immoweb-properties", "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/highbrow_fame~immoweb-properties/runs": { "post": { "operationId": "runs-sync-highbrow_fame-immoweb-properties", "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/highbrow_fame~immoweb-properties/run-sync": { "post": { "operationId": "run-sync-highbrow_fame-immoweb-properties", "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": { "searchUrls": { "title": "Search links", "type": "array", "description": "Set up a search on immoweb.be with all the filters you want and paste the address of the results page. One per line. English, French and Dutch links all work.", "items": { "type": "string" } }, "locations": { "title": "Places", "type": "array", "description": "Or search here without a link: towns, postcodes, provinces or districts — Gent, Anvers, 1050, \"Liège (Province)\", \"Leuven (District)\". A town means all of its postcodes. The filters below apply.", "items": { "type": "string" } }, "transaction": { "title": "For sale or to rent", "enum": [ "sale", "rent" ], "type": "string", "description": "For the places above.", "default": "sale" }, "propertyType": { "title": "Property type", "enum": [ "house-and-apartment", "house", "apartment", "new-project-apartments", "new-project-houses", "land", "office", "commercial", "industry", "garage", "other" ], "type": "string", "description": "For the places above.", "default": "house-and-apartment" }, "minPrice": { "title": "Min price (€)", "minimum": 0, "type": "integer", "description": "Optional. For rent: per month." }, "maxPrice": { "title": "Max price (€)", "minimum": 0, "type": "integer", "description": "Optional. For rent: per month." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Optional." }, "minArea": { "title": "Min living area (m²)", "minimum": 0, "type": "integer", "description": "Optional." }, "maxArea": { "title": "Max living area (m²)", "minimum": 0, "type": "integer", "description": "Optional." }, "epcScores": { "title": "EPC energy scores", "uniqueItems": true, "type": "array", "description": "Optional: only these energy labels (A includes A+ and A++).", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ] } }, "modifiedWithinDays": { "title": "Added or updated within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Optional: only listings added or changed in the last N days." }, "sortBy": { "title": "Sort", "enum": [ "relevance", "newest", "cheapest", "most_expensive" ], "type": "string", "description": "For the places above.", "default": "relevance" }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stops each search after this many listings. Immoweb shows up to about 9,990 per search.", "default": 200 }, "includeDetails": { "title": "Open every listing for its details", "type": "boolean", "description": "Adds the full description, construction year, condition, facades, bathrooms, kitchen, garden and terrace, parking, heating, energy use, cadastral income, flood zone, availability and view count. One more page per listing, so slower.", "default": false }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches to work on at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used only when Immoweb turns a request down: the first try goes out directly.", "default": { "useApifyProxy": 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 } } } } } } } } } }