{ "openapi": "3.0.1", "info": { "title": "Immoweb Agency Scraper: Belgian Real Estate Agencies", "description": "Every Belgian real estate agency on Immoweb.be as a lead list: the agency's own email (not the lead-form relay), phone, website, VAT and IPI numbers, address, opening hours and portfolio size. Add each agency's listings and what it recently sold or let.", "version": "0.3", "x-build-id": "lqZ43aDofrFRi2Pve" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/studioxl~immoweb-agency-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-studioxl-immoweb-agency-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/studioxl~immoweb-agency-scraper/runs": { "post": { "operationId": "runs-sync-studioxl-immoweb-agency-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/studioxl~immoweb-agency-scraper/run-sync": { "post": { "operationId": "run-sync-studioxl-immoweb-agency-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": { "locations": { "title": "Provinces or postal codes", "type": "array", "description": "Get every real estate agency in these places. Use a province in English, French or Dutch (\"Antwerp\", \"Liège\") or a 4-digit postal code (\"9000\" for Ghent). Type \"Belgium\" for the whole country.", "items": { "type": "string" } }, "startUrls": { "title": "Agency pages or IDs", "type": "array", "description": "Optional. Paste agency pages from immoweb.be in any language, for example https://www.immoweb.be/en/agency/century-21-connect/3150337, or just the ID (3150337). These are collected first.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum agencies", "minimum": 0, "type": "integer", "description": "The run stops after this many agencies, so it also caps what you pay. 0 means no limit.", "default": 100 }, "scrapeDetails": { "title": "Full agency profile", "type": "boolean", "description": "Adds the agency's own email, portfolio by property type, recently sold and let counts and reviews. Turn off for a quicker list without email.", "default": true }, "includeListings": { "title": "Add their listings", "type": "boolean", "description": "Every property each agency has online, with price, address, size and agencyId.", "default": false }, "includeSoldOrRented": { "title": "Add recent sales and lettings", "type": "boolean", "description": "Properties the agency recently sold or let, marked listingStatus \"soldOrRented\". Immoweb doesn't show their price.", "default": false }, "listingType": { "title": "Sale, rent or both", "enum": [ "all", "forSale", "forRent" ], "type": "string", "description": "Which listings to keep when you add them.", "default": "all" }, "maxListingsPerAgency": { "title": "Maximum listings per agency", "minimum": 0, "type": "integer", "description": "Keep at most this many listings from each agency. 0 means all of them (the biggest agencies have close to 2,000).", "default": 0 }, "minListings": { "title": "Minimum active listings", "minimum": 0, "type": "integer", "description": "Leave out agencies with fewer listings online, for example 10 to skip very small offices. Agencies you paste by URL or ID are always kept. 0 keeps everyone.", "default": 0 }, "maxItemsPerLocation": { "title": "Maximum agencies per place", "minimum": 0, "type": "integer", "description": "Cap each province or postal code separately, so one busy area doesn't use up the whole run. 0 means no limit.", "default": 0 }, "includeGroups": { "title": "Include group brands", "type": "boolean", "description": "Also return umbrella brands such as Dewaele or Heylen Vastgoed. They have only a name, logo and listing count. Their offices are returned either way.", "default": false }, "proxyConfiguration": { "title": "Connection settings", "type": "object", "description": "Leave as is. The default works on every Apify plan.", "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 } } } } } } } } } }