{ "openapi": "3.0.1", "info": { "title": "Funda Scraper: Dutch Homes for Sale and Rent with Makelaar", "description": "Scrape Funda.nl homes for sale or rent by city or search link: address, postcode, price, price per m², living and plot area, rooms, bedrooms, build year, energy label, status, listing date, makelaar name and phone, photos and description. Only new listings mode. No login.", "version": "0.1", "x-build-id": "jHDSx2QxLWbPU9Gl6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/themineworks~funda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-themineworks-funda-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/themineworks~funda-scraper/runs": { "post": { "operationId": "runs-sync-themineworks-funda-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/themineworks~funda-scraper/run-sync": { "post": { "operationId": "run-sync-themineworks-funda-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": { "areas": { "title": "Cities or areas", "type": "array", "description": "Place names as Funda knows them, one per line: a city (Amsterdam, Den Haag, Utrecht), a province (provincie-utrecht) or a four digit postcode area (1017). Each one is its own search with the filters below. Leave empty when you give Funda links; with neither, Amsterdam is searched.", "items": { "type": "string" } }, "startUrls": { "title": "Funda links", "type": "array", "description": "Optional. Search result links copied from funda.nl after choosing filters there (https://www.funda.nl/zoeken/koop?selected_area=[\"rotterdam\"]&price=\"300000-500000\"), used as they are, or single listing links (https://www.funda.nl/detail/koop/...). A search link to page 3 starts at page 3.", "items": { "type": "string" } }, "offeringType": { "title": "For sale or for rent", "enum": [ "buy", "rent" ], "type": "string", "description": "Homes for sale or for rent. Links keep their own.", "default": "buy" }, "minPrice": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Asking price from, in euros. For rentals, the monthly rent." }, "maxPrice": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Asking price up to, in euros. For rentals, the monthly rent." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Empty means every type Funda shows for homes.", "items": { "type": "string", "enum": [ "house", "apartment", "parking", "land", "storage", "berth", "pitch" ], "enumTitles": [ "House", "Apartment", "Parking", "Building plot", "Storage", "Mooring", "Pitch" ] } }, "minRooms": { "title": "Minimum rooms", "minimum": 1, "maximum": 50, "type": "integer", "description": "Rooms in total, bedrooms included." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 1, "maximum": 50, "type": "integer", "description": "Minimum number of bedrooms." }, "minLivingArea": { "title": "Minimum living area (m²)", "minimum": 1, "type": "integer", "description": "Minimum living area in m²." }, "publishedWithin": { "title": "Listed within", "enum": [ "", "1", "3", "5", "10", "30" ], "type": "string", "description": "Only listings Funda published in this many days.", "default": "" }, "availability": { "title": "Availability", "type": "array", "description": "Which listings to include. Funda's default is available and under offer; add sold or rented for recent sales.", "items": { "type": "string", "enum": [ "available", "negotiations", "unavailable" ], "enumTitles": [ "Available", "Under offer", "Sold or rented" ] }, "default": [ "available", "negotiations" ] }, "sortBy": { "title": "Order", "enum": [ "newest", "relevance", "price_asc", "price_desc", "area_desc" ], "type": "string", "description": "Order of the results for cities and areas. Newest first suits alerts with only new listings. Links keep their own order.", "default": "newest" }, "maxListings": { "title": "Listings per search", "minimum": 20, "maximum": 9990, "type": "integer", "description": "Most listings for each city, area or search link, 20 to 9,990 (Funda shows 666 pages of 15 for one search). You pay per listing delivered.", "default": 100 }, "includeDetails": { "title": "Listing details", "type": "boolean", "description": "On: one quick extra request per listing adds status (available, under offer, sold), build year, asking price per m², property type, bathrooms, description, coordinates, all photos, views and saves, offered since, sale history and every characteristic Funda lists.", "default": true }, "includeAgentPhone": { "title": "Makelaar phone and website", "type": "boolean", "description": "On: the agency's business phone number and website from its Funda page, read once per agency per run.", "default": true }, "onlyNewListings": { "title": "Only listings not delivered before", "type": "boolean", "description": "For alerts on a schedule: skip listings an earlier run with the same searches already delivered, so each run returns and charges only new ones.", "default": false } } }, "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 } } } } } } } } } }