{ "openapi": "3.0.1", "info": { "title": "Huislijn Listings Scraper ($0.50/1K)", "description": "Scrape property listings from Huislijn.nl, the Dutch property portal fed by about 2,500 estate agents: price, address, coordinates, living and plot area, rooms, year built, status for sale and rent, newest first. Optional full details (description, agent) and price history.", "version": "0.0", "x-build-id": "ikzJGIqkWnHhW8jF6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/carabain-digital~huislijn-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-carabain-digital-huislijn-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~huislijn-listings/runs": { "post": { "operationId": "runs-sync-carabain-digital-huislijn-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~huislijn-listings/run-sync": { "post": { "operationId": "run-sync-carabain-digital-huislijn-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": "Dutch city or province. Example: `Utrecht`, `Den Haag` or `Noord-Holland`. Leave empty for all of the Netherlands." }, "listing_type": { "title": "Buy or rent", "enum": [ "sale", "rent" ], "type": "string", "description": "`sale` for properties for sale, `rent` for rentals. Example: `sale`.", "default": "sale" }, "property_type": { "title": "Property type", "enum": [ "house", "apartment", "land", "commercial", "parking" ], "type": "string", "description": "Only this kind of property. Example: `house`. Leave empty for all types. Applied to the scraped listings, so narrow searches are faster." }, "min_price": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Minimum price in euro (monthly rent for rentals). Example: `200000`." }, "max_price": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Maximum price in euro (monthly rent for rentals). Example: `450000`." }, "min_rooms": { "title": "Min rooms", "minimum": 0, "type": "integer", "description": "Minimum number of rooms (kamers). Example: `3`." }, "min_living_area_m2": { "title": "Min living area (m2)", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres. Example: `80`." }, "start_urls": { "title": "Search URLs", "type": "array", "description": "Optional. Search result URLs copied from huislijn.nl, for filters this form does not have, e.g. `https://www.huislijn.nl/koopwoning/nederland/utrecht/utrecht?c-minPrice=300000`. When set, the other search fields are ignored. The Actor adds newest-first sorting unless the URL has an `order`.", "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). A search reaches at most about 10,000 results; split big searches by city or price. Example: `100`. Up to 10,000.", "default": 100 }, "includeDetails": { "title": "Full details (paid add-on)", "type": "boolean", "description": "Also open each listing's detail page: the full description, the estate agent with phone number and agent page, and the energy label when the search result lacks it. Adds $1.00 per 1,000 listings on top of the base price. One extra request per listing. Rentals fed by other portals have a shortened description and no agent.", "default": false }, "trackHistory": { "title": "Price history (paid add-on)", "type": "boolean", "description": "Remember each listing's price and status in a named storage in your own Apify account and add `previous_price`, `price_change`, `price_change_pct`, `status_changed`, `first_seen_at` and `price_history` to every listing you have seen before. Schedule the Actor to build a series. Adds $1.00 per 1,000 listings that already had history (the first sighting is free). 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 keeps the history (lowercase letters, digits and dashes). The same name across runs and across our other real-estate Actors shares one history. Example: `realestate-history`.", "default": "realestate-history" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Huislijn 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 } } } } } } } } } }