{ "openapi": "3.0.1", "info": { "title": "Immoweb Scraper — Belgian Real Estate Data (Immoweb.be)", "description": "Scrape real estate listings from Immoweb.be (Belgium): price, €/m², surface, bedrooms, EPC/PEB energy rating, geolocation, agency. Incremental mode emits only new/changed listings.", "version": "0.1", "x-build-id": "Q5kk63I6Gfj7Wzmeu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/si1ver~immoweb-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-si1ver-immoweb-real-estate-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/si1ver~immoweb-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-si1ver-immoweb-real-estate-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/si1ver~immoweb-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-si1ver-immoweb-real-estate-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", "required": [ "proxyConfiguration" ], "properties": { "scrapeMode": { "title": "Scrape mode", "enum": [ "listing-only", "full-detail" ], "type": "string", "description": "listing-only: data available on search results (cheaper). full-detail: also opens every listing for EPC/PEB energy rating, images, features, agency (premium event charged).", "default": "listing-only" }, "transactionType": { "title": "Transaction type", "enum": [ "sale", "rent" ], "type": "string", "description": "Sale or rent. Used when building searches from locations; ignored when explicit searchUrls are provided (the URL filters win).", "default": "sale" }, "searchUrls": { "title": "Search URLs", "uniqueItems": true, "type": "array", "description": "Immoweb search-result URLs with your filters applied (e.g. https://www.immoweb.be/en/search/house/for-sale?countries=BE). Highest-priority input mode. Tip: use orderBy=newest for reliable incremental monitoring.", "items": { "type": "string" } }, "listingUrls": { "title": "Listing URLs", "uniqueItems": true, "type": "array", "description": "Direct Immoweb classified URLs to scrape one by one. Each is charged as listing-scraped (+ full-detail-scraped, since the detail page is parsed).", "items": { "type": "string" } }, "locations": { "title": "Postal codes", "uniqueItems": true, "type": "array", "description": "Geo mode: Belgian postal codes (e.g. \"1000\", \"9790\"). The actor builds a search per code. Used only when searchUrls and listingUrls are empty. City-name search: use searchUrls instead.", "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Hard cap on listings pushed to the dataset this run (cost control). 0 = unlimited.", "default": 100 }, "onlyNewSinceLastRun": { "title": "Only new/changed since last run", "type": "boolean", "description": "Incremental mode: compare against the dedupe store and emit ONLY listings that are new or whose content changed (changeDetected=true). Unchanged listings are skipped and NOT charged. Use orderBy=newest in your search URL so the same listings reappear run-to-run.", "default": false }, "dedupeStoreName": { "title": "Dedupe store name", "pattern": "^[a-zA-Z0-9-]*$", "type": "string", "description": "Named key-value store holding fingerprints of previously seen listings. Reuse the same name across runs to make incremental mode work. Letters, digits, dashes only.", "default": "immoweb-dedupe" }, "dedupeWithinRun": { "title": "Deduplicate listings within a run", "type": "boolean", "description": "Drop a listing if another with the same geo+price+surface fingerprint was already emitted in this run (the same property advertised twice).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxies are required at scale — DataDome blocks datacenter bursts and bare datacenter IPs. Datacenter proxies are cheapest and often sufficient for Immoweb; switch to RESIDENTIAL if you hit blocks. Belgian (BE) exits are forced on top of this configuration.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }