{ "openapi": "3.0.1", "info": { "title": "NL Adres Geocoding & Buurtdata — PDOK + CBS", "description": "Geocode Nederlandse adressen via PDOK en verrijk ze direct met CBS-buurtstatistieken (inkomen, inwoners, stedelijkheid) — bulk-verwerking, één call, geen losse databronnen combineren.", "version": "0.4", "x-build-id": "G8frrdW20HRwaNuoh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/codeclouds~pdok-locatieserver/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-codeclouds-pdok-locatieserver", "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/codeclouds~pdok-locatieserver/runs": { "post": { "operationId": "runs-sync-codeclouds-pdok-locatieserver", "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/codeclouds~pdok-locatieserver/run-sync": { "post": { "operationId": "run-sync-codeclouds-pdok-locatieserver", "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": { "mode": { "title": "Modus", "enum": [ "auto", "forward", "reverse", "lookup" ], "type": "string", "description": "Welke API-modus gebruiken. 'auto' detecteert op basis van input: coördinaten → reverse, lookupId → lookup, anders → forward.", "default": "auto" }, "query": { "title": "Zoekopdracht (enkele)", "type": "string", "description": "Vrije zoektekst voor één forward/reverse/lookup. Voor bulk: gebruik 'queries' (array) of koppel een dataset. Voor reverse: 'lat,lon' (bv. '52.3789,4.8952'). Voor lookup: object-ID." }, "queries": { "title": "Queries (bulk)", "type": "array", "description": "Array van zoekopdrachten voor bulk-verwerking. Elk element kan een string zijn ('Damrak 1 Amsterdam') of een object {query, lookupId, mode}. Wordt genegeerd als leeg — dan valt de actor terug op 'query' of een gekoppeld dataset." }, "lookupId": { "title": "PDOK Object-ID (voor lookup)", "type": "string", "description": "PDOK object-ID (bv. 'adr-8f4d573be765b4c80dd635ba73747903') om een specifiek object op te halen. Wordt genegeerd tenzij mode='lookup' of auto-detectie." }, "datasetId": { "title": "Gekoppeld input-dataset (ID of naam)", "type": "string", "description": "ID of naam van een bestaand Apify dataset waaruit items gelezen worden (velden 'query'/'address'/'adres', optioneel 'lookupId' en 'mode'), bv. 'jXxQ3RWG9G2Y8hUJT'. Wordt alleen gebruikt als 'query' en 'queries' beide leeg zijn. Laat leeg om deze feature niet te gebruiken." }, "concurrency": { "title": "Gelijktijdige requests (batch)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Aantal items dat tegelijk wordt verwerkt bij bulk-input. Hoger = sneller, maar meer load op PDOK. Max 20.", "default": 5 }, "maxResults": { "title": "Max. aantal resultaten", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum aantal resultaten (1-100, API-limiet).", "default": 5 }, "typeFilter": { "title": "Type filter", "enum": [ "", "adres", "postcode", "woonplaats", "gemeente", "weg", "perceel" ], "type": "string", "description": "Beperk zoekopdracht tot een specifiek objecttype.", "default": "" }, "distance": { "title": "Zoekstraal (meter, reverse)", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Alleen bij reverse geocoding: maximale afstand in meters rond het opgegeven punt, bv. 50." }, "enrichWithCbs": { "title": "Verrijken met CBS-buurtdata", "type": "boolean", "description": "Voeg CBS Kerncijfers Wijken en Buurten (inwoners, inkomen, huishoudens, stedelijkheid) toe aan elk resultaat op basis van de gevonden buurt-/wijk-/gemeentecode. Kost geen extra PPE-kosten bovenop de bestaande prijs per resultaat.", "default": false }, "cbsTableId": { "title": "CBS StatLine tabel-ID", "type": "string", "description": "CBS StatLine-tabel om te gebruiken voor de buurtverrijking (alleen relevant als 'Verrijken met CBS-buurtdata' aanstaat). Standaard de meest recente 'Kerncijfers Wijken en Buurten'-tabel.", "default": "86165NED" }, "cbsFields": { "title": "CBS-velden (zoektermen)", "type": "array", "description": "Zoektermen die dynamisch tegen de kolomtitels van de gekozen CBS-tabel gematcht worden (alleen relevant als 'Verrijken met CBS-buurtdata' aanstaat). CBS wijzigt kolomcodes per jaargang, dus matching gebeurt op zoekterm i.p.v. hardcoded kolomcode.", "default": [ "aantal inwoners", "gemiddeld inkomen per inwoner", "huishoudens totaal", "stedelijkheid" ] } } }, "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 } } } } } } } } } }