{ "openapi": "3.0.1", "info": { "title": "WOZ API Waardeloket (PPE)", "description": "Scrape WOZ (Waardering Onroerende Zaken) property values from the official Dutch WOZ Waardeloket and BAG Viewer. Get comprehensive property data including WOZ values history, building information, and cadastral data. WOZ API, Kadaster API, vastgoed data API", "version": "0.0", "x-build-id": "1k6fdKc3nLTyp0aVC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nocodeventure~woz-api-waardeloket-ppe/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nocodeventure-woz-api-waardeloket-ppe", "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/nocodeventure~woz-api-waardeloket-ppe/runs": { "post": { "operationId": "runs-sync-nocodeventure-woz-api-waardeloket-ppe", "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/nocodeventure~woz-api-waardeloket-ppe/run-sync": { "post": { "operationId": "run-sync-nocodeventure-woz-api-waardeloket-ppe", "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", "required": [ "streetAddress", "postcode", "city" ], "properties": { "streetAddress": { "title": "Street Address", "type": "string", "description": "Street name and house number (e.g., 'Kloosterlaan 33')" }, "postcode": { "title": "Postcode", "pattern": "^[0-9]{4}[A-Za-z]{2}$", "type": "string", "description": "Dutch postcode (e.g., '1216NH')" }, "city": { "title": "City", "type": "string", "description": "City name (e.g., 'Hilversum')" }, "downloadWozPdf": { "title": "Download WOZ PDF", "type": "boolean", "description": "Download the WOZ value PDF from WOZ Waardeloket. PDF will be stored in the key-value store.", "default": false }, "enableBagViewer": { "title": "Enable BAG Viewer", "type": "boolean", "description": "Fetch additional building data from BAG Viewer (Kadaster). This provides extra property information like building year and status.", "default": true }, "downloadBagPdf": { "title": "Download BAG PDF", "type": "boolean", "description": "Download the BAG PDF from BAG Viewer. Only works if BAG Viewer is enabled. PDF will be stored in the key-value store.", "default": false }, "enableDebugScreenshot": { "title": "Enable Debug Screenshot", "type": "boolean", "description": "Capture a debug screenshot when address lookup fails. Useful for troubleshooting. Screenshot will be stored in the key-value store.", "default": false }, "maxRequestsPerCrawl": { "title": "Max Requests per Crawl", "type": "integer", "description": "Maximum number of requests that can be made by this crawler.", "default": 25 }, "maxRequestRetries": { "title": "Max Request Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Maximum number of retries for failed requests. Set to 0 for no retries (recommended for address lookups). Maximum allowed is 5.", "default": 0 }, "addressLookupTimeoutSecs": { "title": "Address Lookup Timeout (seconds)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Timeout in seconds for address lookup. The WOZ site is fast, so valid addresses typically load in 1-2 seconds. Maximum is 10 seconds.", "default": 8 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for the crawler.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }