{ "openapi": "3.0.1", "info": { "title": "Zimmo Listings Scraper ($0.50/1K)", "description": "Scrape real-estate listings from Zimmo (zimmo.be), Belgium: houses, apartments, land and commercial property for sale and for rent. Filter by city or postcode, price, bedrooms, living area and type. Price, address, EPC, agent, photos and the site's own price history. Fast, no proxy needed.", "version": "0.0", "x-build-id": "8TpCEqqepmebdhEiR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/carabain-digital~zimmo-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-carabain-digital-zimmo-listings", "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/carabain-digital~zimmo-listings/runs": { "post": { "operationId": "runs-sync-carabain-digital-zimmo-listings", "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/carabain-digital~zimmo-listings/run-sync": { "post": { "operationId": "run-sync-carabain-digital-zimmo-listings", "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": { "location": { "title": "Location", "type": "string", "description": "Belgian city, municipality or postcode. Several values separated by commas (all postcodes or all names). Example: `Gent`, `Antwerpen` or `9000, 9050`. Leave empty for all of Belgium. Ignored when you give search URLs." }, "listing_type": { "title": "Sale or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "`sale` for properties to buy, `rent` for rentals. Example: `rent`.", "default": "sale" }, "property_type": { "title": "Property type", "enum": [ "any", "house", "apartment", "land", "commercial", "parking", "room" ], "type": "string", "description": "Type of property. `any` = all types. Example: `apartment`.", "default": "any" }, "min_price": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Lowest price in euro (rent: per month). Example: `200000`, for rent `800`." }, "max_price": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Highest price in euro (rent: per month). Example: `450000`, for rent `1500`." }, "min_rooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms. Example: `2`." }, "min_living_area_m2": { "title": "Minimum living area (m2)", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres. Listings without a known area are left out when this is set. Example: `80`." }, "start_urls": { "title": "Search URLs (optional)", "type": "array", "description": "Search result pages copied from zimmo.be; they replace the filters above. Example: `https://www.zimmo.be/nl/gent/te-koop/appartement` or an advanced-search URL (`/nl/uitgebreid-zoeken?search=...`). Leave empty to use the filters above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "limit": { "title": "Max listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many listings (newest first). Example: `100`. Zimmo returns at most about 9,950 results per search: use a place or price range to go deeper.", "default": 100 }, "trackHistory": { "title": "Price history (paid add-on)", "type": "boolean", "description": "Keep the price and status of every listing in a named store in your own Apify account and add first_seen_at, previous_price, price_change, price_change_pct, status_changed and price_history to each item. Run it on a schedule: the first run only starts the series. Adds $1.00 per 1,000 listings that already had history. Do not run two runs on the same store at once.", "default": false }, "historyStoreName": { "title": "History store name", "type": "string", "description": "Name of the key-value store that holds the history (letters a-z, digits, dashes). All our real-estate Actors use `realestate-history` by default, so history is shared between them. Use another name to keep a separate series per search, e.g. `gent-apartments`.", "default": "realestate-history" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Zimmo works without a proxy. Enable one only if runs get blocked." } } }, "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 } } } } } } } } } }