{ "openapi": "3.0.1", "info": { "title": "Immoweb Scraper", "description": "Immoweb is Belgium's biggest property portal, and pricing a house means comparing it against dozens of others in the same postal code. Rows give price, previous price on reductions, bedrooms, surface, EPC score and sale-or-rent. Street numbers and coordinates never collected.", "version": "0.1", "x-build-id": "4uDKQo3epTA89u1yq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lowlanddata~immoweb-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lowlanddata-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/lowlanddata~immoweb-scraper/runs": { "post": { "operationId": "runs-sync-lowlanddata-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/lowlanddata~immoweb-scraper/run-sync": { "post": { "operationId": "run-sync-lowlanddata-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", "garage", "office", "land" ], "type": "string", "description": "What kind of property to search: houses and apartments together (default), or one category.", "default": "house-and-apartment" }, "transaction": { "title": "For sale or for rent", "enum": [ "sale", "rent" ], "type": "string", "description": "Search properties for sale or for rent.", "default": "sale" }, "postalCodes": { "title": "Postal codes", "type": "string", "description": "Comma-separated Belgian postal codes to search in, e.g. \"1000,1050\". Leave empty to search all of Belgium." }, "priceMinEur": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Only include listings priced at least this many euros. For rentals this is euros per month." }, "priceMaxEur": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Only include listings priced at most this many euros. For rentals this is euros per month." }, "bedroomsMin": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include properties with at least this many bedrooms." }, "sortBy": { "title": "Sort by", "enum": [ "newest", "cheapest", "most_expensive", "relevance" ], "type": "string", "description": "Order of results: newest (best for monitoring), cheapest, most_expensive, or relevance.", "default": "newest" }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after this many listings. Free-plan runs are capped at 5 items. The form starts at 25 for a cheap first run - that is the form's prefill, not a cap on your plan; clear it to use the default of 1000. One run cannot return more than about 10,020 items however high you set this: Immoweb serves 334 pages of 30 results for a search.", "default": 1000 }, "scrapeDetails": { "title": "Fetch descriptions", "type": "boolean", "description": "Read each listing's own classified page for the seller's full property description, which the search results do not carry. This makes one extra request per listing, so a run is slower and costs one more page fetch each. The agency or advertiser contact block is never read - no name, email or phone reaches the output. Leave off for a fast search-only sweep.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Keep Apify proxy enabled.", "default": { "useApifyProxy": true } }, "reportFailures": { "title": "Report failures to the developer", "type": "boolean", "description": "When a run fails, send the developer the actor name and build, an error category, the error message (truncated) and a one-way hash of your input - so a bug can be fixed without anyone asking you to reproduce it. Your input itself, your results and your identity are never sent, and successful runs send nothing at all. Switch this off and the actor behaves exactly the same.", "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 } } } } } } } } } }