{
"openapi": "3.0.1",
"info": {
"title": "Immoweb Scraper - Belgium Real Estate & Agency Leads",
"description": "Scrape Immoweb.be, Belgium's #1 real estate portal: houses & apartments for sale and rent with prices, EPC energy score, full specs, all photos, geo and agency leads (email, phone & website). Filter by postal code, province, price & type. Monitor new listings. Export JSON, CSV.",
"version": "0.1",
"x-build-id": "sSZYVQFwa9DuAkIEo"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~immoweb-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~immoweb-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-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/scrapesage~immoweb-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-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": {
"transactionType": {
"title": "For sale or for rent",
"enum": [
"for-sale",
"for-rent"
],
"type": "string",
"description": "Scrape properties for sale or for rent.",
"default": "for-sale"
},
"propertyType": {
"title": "Property type",
"enum": [
"house-and-apartment",
"house",
"apartment",
"new-real-estate",
"apartment-block",
"house-group",
"land",
"garage",
"office",
"business",
"industry"
],
"type": "string",
"description": "Which kind of property to scrape. house-and-apartment covers both (the default).",
"default": "house-and-apartment"
},
"postalCodes": {
"title": "Postal codes",
"type": "array",
"description": "Belgian postal codes to search, e.g. 1000 (Brussels), 2000 (Antwerp), 9000 (Ghent), 4000 (Liège). Leave empty to search all of Belgium (or use provinces / Start URLs).",
"items": {
"type": "string"
}
},
"provinces": {
"title": "Provinces",
"type": "array",
"description": "Belgian provinces to search instead of, or in addition to, postal codes.",
"items": {
"type": "string",
"enum": [
"BRUSSELS",
"ANTWERP",
"EAST_FLANDERS",
"WEST_FLANDERS",
"FLEMISH_BRABANT",
"WALLOON_BRABANT",
"LIEGE",
"HAINAUT",
"NAMUR",
"LUXEMBOURG",
"LIMBURG"
],
"enumTitles": [
"Brussels",
"Antwerp",
"East Flanders",
"West Flanders",
"Flemish Brabant",
"Walloon Brabant",
"Liège",
"Hainaut",
"Namur",
"Luxembourg",
"Limburg"
]
}
},
"startUrls": {
"title": "Start URLs",
"type": "array",
"description": "Paste any Immoweb URL — a search page (https://www.immoweb.be/en/search/house/for-sale/...) or a listing (https://www.immoweb.be/en/classified/...). The easiest way to scrape an exact search: build it on immoweb.be with the filters you want, then paste the URL. Used in addition to postal codes / provinces.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"listingUrls": {
"title": "Listing URLs",
"type": "array",
"description": "Direct Immoweb listing URLs (https://www.immoweb.be/en/classified/...) to scrape full detail (and agency contact) for. Each becomes a full detail record.",
"items": {
"type": "string"
}
},
"priceMin": {
"title": "Min price (€)",
"minimum": 0,
"type": "integer",
"description": "Only listings at or above this price. For rentals this is the monthly rent."
},
"priceMax": {
"title": "Max price (€)",
"minimum": 0,
"type": "integer",
"description": "Only listings at or below this price (monthly rent for rentals)."
},
"minBedrooms": {
"title": "Min bedrooms",
"minimum": 0,
"type": "integer",
"description": "Minimum number of bedrooms."
},
"maxBedrooms": {
"title": "Max bedrooms",
"minimum": 0,
"type": "integer",
"description": "Maximum number of bedrooms."
},
"minSurface": {
"title": "Min living area (m²)",
"minimum": 0,
"type": "integer",
"description": "Minimum net habitable surface in square metres."
},
"maxSurface": {
"title": "Max living area (m²)",
"minimum": 0,
"type": "integer",
"description": "Maximum net habitable surface in square metres."
},
"orderBy": {
"title": "Sort order",
"enum": [
"newest",
"relevance",
"cheapest",
"most_expensive"
],
"type": "string",
"description": "How to order results. Newest first is recommended for monitoring.",
"default": "newest"
},
"includeListingDetails": {
"title": "Include full listing details",
"type": "boolean",
"description": "For every listing, open its page and add the full description, every spec (construction year, building condition, EPC energy score & consumption, heating, kitchen, all amenities — garden/terrace/parking/pool/lift…), cadastral income, monthly costs, complete photo gallery & floor plans, view & bookmark counts — and the agency's direct email, phone & website. Charged as listingDetail. Slower but far richer.",
"default": false
},
"outputAgencyLeads": {
"title": "Output agency leads",
"type": "boolean",
"description": "Also output one deduplicated lead record (type = \"agencyLead\") per unique estate agency behind the scraped listings — name, direct email, phone, mobile & website, address, active-listing count, areas, property types, price range, sample listings and a 0–100 lead score. Requires opening listing pages, so this turns on full listing details.",
"default": false
},
"maxResults": {
"title": "Max results",
"minimum": 1,
"type": "integer",
"description": "Maximum number of listing records to scrape across all searches. Belgium has tens of thousands of listings — use locations, type and price filters to focus.",
"default": 100
},
"maxAgencyLeads": {
"title": "Max agency leads",
"minimum": 1,
"type": "integer",
"description": "Maximum number of agency-lead records to emit (when agency leads are on).",
"default": 200
},
"maxPagesPerSearch": {
"title": "Max pages per search",
"minimum": 1,
"maximum": 333,
"type": "integer",
"description": "How many result pages (30 listings each) to page through per search.",
"default": 100
},
"monitorMode": {
"title": "Monitoring mode — only new records",
"type": "boolean",
"description": "Remember listings across runs in a named key-value store and emit ONLY what's new since last run — new listings and any with a changed price (flagged priceChangedSinceLastRun). Perfect for new-listing alerts and price-drop watches. Works with Apify Schedules.",
"default": false
},
"monitorKey": {
"title": "Monitor key",
"type": "string",
"description": "Names the memory used by monitoring mode. Use a distinct key per saved search so different watches don't share state.",
"default": "default"
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxy settings. Residential proxies (Belgium) are recommended and used by default for the most reliable access.",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}