{ "openapi": "3.0.1", "info": { "title": "Funda Netherlands Real Estate Scraper", "description": "Scrape property listings from Funda.nl — the largest real estate platform in the Netherlands. Supports buy and rent, all property types, price ranges, locations, and detailed filters.", "version": "1.0", "x-build-id": "gdWj0kMz4oA0CJoaf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rigelbytes~funda-nl-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rigelbytes-funda-nl-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/rigelbytes~funda-nl-scraper/runs": { "post": { "operationId": "runs-sync-rigelbytes-funda-nl-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/rigelbytes~funda-nl-scraper/run-sync": { "post": { "operationId": "run-sync-rigelbytes-funda-nl-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": { "startUrls": { "title": "Funda Search URLs (optional)", "type": "array", "description": "Paste full Funda search result URLs copied from your browser. Parameters are extracted from the URL; any filter not in the URL is taken from the input fields below. URLs without a location search nationwide. Optional: add Search Locations to restrict to a city when the URL has no selected_area.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Search Locations", "type": "array", "description": "City names, neighborhoods, or postal codes (e.g. Amsterdam, Rotterdam, 1012AB). Ignored when Funda Search URLs are provided.", "items": { "type": "string" } }, "offeringType": { "title": "Offering Type", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy or rent. Ignored when Funda Search URLs are provided.", "default": "buy" }, "minPrice": { "title": "Minimum Price (€)", "minimum": 0, "type": "integer", "description": "Minimum asking price. Buy: total sale price. Rent: monthly rent." }, "maxPrice": { "title": "Maximum Price (€)", "minimum": 0, "type": "integer", "description": "Maximum asking price." }, "propertyTypes": { "title": "Property Types", "uniqueItems": true, "type": "array", "description": "Leave empty for all property types.", "items": { "type": "string", "enum": [ "apartment", "house", "parking", "berth", "pitch", "land", "storage", "storage_space", "substructure" ], "enumTitles": [ "Apartment", "House", "Parking", "Berth", "Pitch", "Land", "Storage", "Storage Space", "Substructure" ] }, "default": [ "apartment", "house" ] }, "constructionType": { "title": "Construction Type", "enum": [ "", "resale", "newly_built" ], "type": "string", "description": "Filter by construction type" }, "minFloorArea": { "title": "Minimum Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum living area in square meters" }, "maxFloorArea": { "title": "Maximum Floor Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum living area in square meters" }, "minPlotArea": { "title": "Minimum Plot Area (m²)", "minimum": 0, "type": "integer", "description": "Minimum plot/land area in square meters" }, "maxPlotArea": { "title": "Maximum Plot Area (m²)", "minimum": 0, "type": "integer", "description": "Maximum plot/land area in square meters" }, "minRooms": { "title": "Minimum Rooms", "minimum": 0, "type": "integer", "description": "Minimum number of rooms" }, "maxRooms": { "title": "Maximum Rooms", "minimum": 0, "type": "integer", "description": "Maximum number of rooms" }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms" }, "maxBedrooms": { "title": "Maximum Bedrooms", "minimum": 0, "type": "integer", "description": "Maximum number of bedrooms" }, "publicationDate": { "title": "Publication Date", "enum": [ "no_preference", "1", "3", "7", "10", "14", "30" ], "type": "string", "description": "Show listings published within this time frame", "default": "no_preference" }, "availability": { "title": "Availability", "enum": [ "available", "negotiations", "available_and_negotiations", "sold" ], "type": "string", "description": "Filter by availability status", "default": "available" }, "energyLabels": { "title": "Energy Labels", "uniqueItems": true, "type": "array", "description": "Leave empty for all energy labels.", "items": { "type": "string", "enum": [ "A++++", "A+++", "A++", "A+", "A", "B", "C", "D", "E", "F", "G" ], "enumTitles": [ "A++++", "A+++", "A++", "A+", "A", "B", "C", "D", "E", "F", "G" ] }, "default": [] }, "exteriorSpaceTypes": { "title": "Exterior Space Types", "uniqueItems": true, "type": "array", "description": "Leave empty for all exterior space types.", "items": { "type": "string", "enum": [ "garden", "balcony", "terrace" ], "enumTitles": [ "Garden", "Balcony", "Terrace" ] }, "default": [] }, "hasGarden": { "title": "Has Garden", "type": "boolean", "description": "Only show properties with a garden (shortcut for Exterior Space Types → Garden)", "default": false }, "constructionPeriods": { "title": "Construction Periods", "uniqueItems": true, "type": "array", "description": "Leave empty for all construction periods.", "items": { "type": "string", "enum": [ "before_1906", "from_1906_to_1930", "from_1931_to_1944", "from_1945_to_1959", "from_1960_to_1970", "from_1971_to_1980", "from_1981_to_1990", "from_1991_to_2000", "from_2001_to_2010", "from_2011_to_2020", "after_2020" ], "enumTitles": [ "Before 1906", "1906–1930", "1931–1944", "1945–1959", "1960–1970", "1971–1980", "1981–1990", "1991–2000", "2001–2010", "2011–2020", "After 2020" ] }, "default": [] }, "surroundingTypes": { "title": "Surrounding Area", "uniqueItems": true, "type": "array", "description": "Leave empty for all surrounding area types.", "items": { "type": "string", "enum": [ "rural", "in_center", "by_water", "at_edge_of_woods", "overlooking_park", "in_green_area", "in_residential_district", "in_recreation_park", "in_business_park", "on_busy_road", "on_quiet_road", "on_navigable_waterway", "open_position", "outside_built_up_area", "sheltered_position", "sea_view", "unobstructed_view" ], "enumTitles": [ "Rural", "City Center", "By Water", "At Edge of Woods", "Overlooking Park", "In Green Area", "In Residential District", "In Recreation Park", "In Business Park", "On Busy Road", "On Quiet Road", "On Navigable Waterway", "Open Position", "Outside Built-up Area", "Sheltered Position", "Sea View", "Unobstructed View" ] }, "default": [] }, "garageAllGarages": { "title": "Garage: All Garages", "type": "boolean", "description": "Filter for properties with any garage type", "default": false }, "garageBasement": { "title": "Garage: Basement", "type": "boolean", "description": "Filter for properties with a basement garage", "default": false }, "garageBuiltIn": { "title": "Garage: Built-in", "type": "boolean", "description": "Filter for properties with a built-in garage", "default": false }, "garageCarport": { "title": "Garage: Carport", "type": "boolean", "description": "Filter for properties with a carport", "default": false }, "garageDetached": { "title": "Garage: Detached", "type": "boolean", "description": "Filter for properties with a detached garage", "default": false }, "garageAndCarport": { "title": "Garage: Garage and Carport", "type": "boolean", "description": "Filter for properties with both garage and carport", "default": false }, "garagePossible": { "title": "Garage: Garage Possible", "type": "boolean", "description": "Filter for properties where a garage can be built", "default": false }, "garageLeanTo": { "title": "Garage: Lean-to", "type": "boolean", "description": "Filter for properties with a lean-to garage", "default": false }, "garageLockUp": { "title": "Garage: Lock-up", "type": "boolean", "description": "Filter for properties with a lock-up garage", "default": false }, "garageParkingSpace": { "title": "Garage: Parking Space", "type": "boolean", "description": "Filter for properties with a garage parking space", "default": false }, "garageUnderground": { "title": "Garage: Underground", "type": "boolean", "description": "Filter for properties with an underground garage", "default": false }, "parkingOnEnclosedProperty": { "title": "Parking: On Enclosed Property", "type": "boolean", "description": "Filter for parking on enclosed property", "default": false }, "parkingOnPrivateProperty": { "title": "Parking: On Private Property", "type": "boolean", "description": "Filter for parking on private property", "default": false }, "parkingPaidParking": { "title": "Parking: Paid Parking", "type": "boolean", "description": "Filter for paid parking nearby", "default": false }, "parkingGarage": { "title": "Parking: Parking Garage", "type": "boolean", "description": "Filter for parking garage availability", "default": false }, "parkingPermits": { "title": "Parking: Parking Permits", "type": "boolean", "description": "Filter for parking permit availability", "default": false }, "parkingPublic": { "title": "Parking: Public Parking", "type": "boolean", "description": "Filter for public parking nearby", "default": false }, "freeTextSearch": { "title": "Free Text Search", "type": "string", "description": "Search within listing descriptions and details" }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "price_asc", "price_desc", "floor_area_desc", "publication_date_desc" ], "type": "string", "description": "How to sort the results", "default": "relevance" }, "extractDetails": { "title": "Extract Listing Details", "type": "boolean", "description": "When enabled, includes the full listing description, property features, coordinates, and complete photo gallery for each result.", "default": false }, "extractAgentContact": { "title": "Extract Agent Phone & Contact", "type": "boolean", "description": "When enabled, includes the agent phone number, contact person name, and office details when available.", "default": false }, "detailConcurrency": { "title": "Detail Request Concurrency", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of listings processed in parallel when detail extraction is enabled.", "default": 10 }, "maxItems": { "title": "Max Items", "minimum": 0, "type": "integer", "description": "Maximum number of listings to scrape (0 = no limit)", "default": 100 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxy is required for reliable runs on Apify Cloud. The default enables Apify residential proxy.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }