{ "openapi": "3.1.0", "info": { "title": "GetApi", "version": "0.0.1", "description": "## Authentication\n\nAll API endpoints require authentication. Include your API key in every request using **one** of the following methods:\n\n**Option 1 \u2014 X-Api-Key header (recommended)**\n```\nX-Api-Key: ga_live_xxxxxxxxxxxxxxxxxxxx\n```\n\n**Option 2 \u2014 Bearer token**\n```\nAuthorization: Bearer ga_live_xxxxxxxxxxxxxxxxxxxx\n```\n\nYou can generate and manage API keys in your [dashboard](https://getapi.nl/dashboard).\n\n## AI & Agent Payments (x402)\n\nSome endpoints support direct payments for AI agents via the **x402** protocol (https://www.x402.org).\nNo API key or account is needed. Send a normal request without key;\nthe server will respond with **HTTP 402** and a `PAYMENT-REQUIRED` header:\n\n```\nPAYMENT-REQUIRED: \n```\n\nThis base64 string contains, among other things, `network`, `asset`, `amount`, and `payTo`. \nYour agent signs an EIP-3009 *transferWithAuthorization* for the specified `amount` of USDC to that `payTo` address, \nencodes the signature as base64, and resubmits the request with:\n\n```\nPAYMENT-SIGNATURE: \n```\n\nThe server verifies the signature via a facilitator, provides the data, and settles the payment on-chain. \nThe success response includes a `PAYMENT-RESPONSE` header containing the transaction information. \nA one-time `nonce` prevents replay attacks. Payments are made in USDC on **Base**; \nthe price is determined by the `credit_cost` of the endpoint.", "contact": { "email": "info@wdnoord.nl" }, "x-guidance": "GetAPI.nl is een Nederlandse API-platform voor lookups en validaties (postcode,\nadres, kenteken, BTW, e-mail, KVK, IBAN, energiemaatwerk, overheidsdata). Elke\nendpoint accepteert een API key via de X-Api-Key header of Authorization:\nBearer .\n\nSommige endpoints zijn ook direct betaalbaar voor AI-agents via het x402-protocol\n(https://www.x402.org) zonder account of API key: stuur een verzoek zonder key,\nde server antwoordt met HTTP 402 en een PAYMENT-REQUIRED header (base64 JSON met\nnetwork, asset, amount, payTo). Teken daarna een EIP-3009 transferWithAuthorization\nvoor het gevraagde bedrag in USDC op Base en hertrail met een PAYMENT-SIGNATURE\nheader. De server verifieert, levert de data en settleert on-chain.\n\nTips voor agents:\n- Lees eerst de PAYMENT-REQUIRED header van een 402-antwoord; die is leidend.\n- Geef altijd de exact door de server gevraagde parameters mee.\n- Een endpoint met een \"x-payment-info\" blok vereist betaling voor gebruik." }, "servers": [ { "url": "https://api.getapi.nl", "description": "GetAPI" } ], "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] }, { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "paths": { "/v1/property/pandgegevens": { "get": { "operationId": "property.pandgegevens", "description": "Returns combined property data for a Dutch address: Address details + BAG identifiers, Energy label info,\nproperty value (WOZ waarde), spatial planning data, and environmental information.\n\nHet blok `energy_labels` bevat \u00e1lle EP-Online-labels voor dit adres (volledige\nrecords, inclusief historie); `energy_label`, `energy_details` en `building`\nblijven het meest recente label in de gesubseteerde vorm weergeven.\n\nThis API combines multiple data sources and provides comprehensive property information\nthat is not easily available elsewhere. Also keep in mind that due the multiple underlying\nAPI calls, the response time for this endpoint may be longer than typical lookup endpoints, especially on cache misses.\n\nResults are cached for 24 hours.", "summary": "Property data lookup (pandgegevens)", "tags": [ "Property data", "Pandgegevens" ], "parameters": [ { "name": "postcode", "in": "query", "required": true, "schema": { "type": "string", "pattern": "^[1-9][0-9]{3}\\s?[A-Za-z]{2}$" } }, { "name": "house_number", "in": "query", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 99999 } }, { "name": "house_letter", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z]{1}$" } }, { "name": "house_number_addition", "in": "query", "schema": { "type": [ "string", "null" ], "pattern": "^[a-zA-Z0-9]{1,4}$", "maxLength": 4 } } ], "responses": { "200": { "description": "Property data found", "content": { "application/json": { "schema": { "type": "object", "examples": [ { "found": true, "address": { "bag_nummeraanduiding_id": "0363200000218908", "bag_verblijfsobject_id": "0363010000218908", "bag_pand_ids": [ "0363100012165277" ], "bag_openbare_ruimte_id": "0363300000006316", "bag_woonplaats_id": "3594", "street": "Damrak", "short_name": "Damrak", "house_number": 1, "house_letter": null, "house_number_addition": null, "postcode": "1012LG", "city": "Amsterdam", "municipality": "Amsterdam", "address_line": "Damrak 1", "address_line_postal": "1012 LG AMSTERDAM", "usage_purposes": [ "retail" ], "surface_area_m2": 312, "build_year": 1900, "status": "in_use", "type": "residence", "is_secondary_address": false, "is_observed": false, "in_investigation": null, "document_date": "2019-11-22", "document_number": "19SZ2048", "secondary_address_ids": [], "occurrence": null, "lat": 52.3745, "lon": 4.8986 }, "bag_identifiers": { "nummeraanduiding_id": "1234567890123456", "verblijfsobject_id": "1234567890123456", "openbareruimte_id": "1234567890123456" }, "energy_labels": [ { "registration_date": "2024-08-30T22:25:14.623", "recording_date": "2024-08-26T00:00:00", "valid_until": "2034-08-26T00:00:00", "certificate_holder": "Prosperos B.V.", "recording_type": "Basisopname", "status": "Bestaand", "calculation_type": "NTA 8800:2024 (basisopname utiliteitsbouw)", "is_simplified_label": null, "based_on_reference_building": false, "building_class": "Utiliteitsbouw", "building_type": null, "building_subtype": null, "sbi_code": null, "zipcode": "1012LG", "house_number": 1, "house_letter": null, "house_number_addition": null, "detail_description": null, "bag_residence_id": "0363010012111931", "bag_mooring_id": null, "bag_stand_id": null, "bag_building_ids": [ "0363100012185508" ], "construction_year": 1890, "usable_area_thermal_zone": 16131.58, "compactness": 0.51, "energy_class": "A+", "energy_index": null, "energy_index_emg_forfeit": null, "energy_demand": 112.77, "primary_fossil_energy": 177.25, "primary_fossil_energy_emg_forfeit": null, "renewable_energy_share": 19.4, "renewable_energy_share_emg_forfeit": null, "temperature_overrun": null, "heat_demand": 74.62, "requirement_energy_demand": null, "requirement_primary_fossil_energy": null, "requirement_renewable_energy_share": null, "requirement_temperature_overrun": null, "calculated_co2_emission": 36.99, "calculated_energy_consumption": 177.24 } ], "energy_label": { "label": "C", "energy_class": "C", "energy_index": 1.4, "building_class": "residential", "building_type": "apartment", "building_subtype": "corner_apartment", "construction_year": 1925, "calculated_co2_emission": 12.5, "calculated_energy_consumption": 85.3, "registration_date": "2024-01-01", "valid_until": "2034-01-01" }, "energy_details": { "recording": { "recording_date": "2024-01-01", "recording_type": "full_calculation", "certificate_holder": "Example Company", "status": "valid", "calculation_type": "detailed", "is_simplified_label": false, "based_on_reference_building": false }, "energy_performance": { "energy_index_emg_forfeit": 1.35, "energy_demand": 75.2, "primary_fossil_energy": 120.5, "primary_fossil_energy_emg_forfeit": 118.3, "renewable_energy_share": 15.2, "renewable_energy_share_emg_forfeit": 16.8, "temperature_overrun": 2.1, "heat_demand": 45.8 }, "requirements": { "energy_demand": 70, "primary_fossil_energy": 115, "renewable_energy_share": 14, "temperature_overrun": 2 }, "bag_building_ids": [ "1234567890123456" ], "sbi_code": "4110", "detail_description": "Detailed building description" }, "property_value": { "amount": 475000, "reference_date": "2024-01-01", "history": [ { "amount": 450000, "reference_date": "2023-01-01" }, { "amount": 425000, "reference_date": "2022-01-01" }, { "amount": 400000, "reference_date": "2021-01-01" } ] }, "building": { "surface_area": 72, "construction_year": 1925, "type": "residential", "subtype": "apartment", "class": "residential", "compactness": 0.85 }, "spatial_planning": { "agrarisch": false, "type": "Wonen", "plan": "Bestemmingsplan Centrum", "plan_id": "NL.IMRO.1234.BP1234", "plan_url": "https://www.ruimtelijkeplannen.nl/viewer/viewer?planidn=NL.IMRO.1234.BP1234", "plan_status": "vastgesteld", "plan_datum": "2023-06-15", "overheid": "Gemeente Voorbeeldstad", "bestemmingsvlak": { "id": "12345", "naam": "Wonen", "type": "bestemmingsvlak", "bestemmingshoofdgroep": "Wonen", "artikelnummer": "3.1", "verwijzingNaarTekst": [ "Artikel 3 Wonen" ] }, "plannen": [], "copyright": "Gegevens geleverd door Digitaal Stelsel Omgevingswet (DSO-LV) onder CC-BY licentie." }, "environmental_info": { "mogelijk": true, "reden": "Woonfunctie aanwezig in bestemmingsvlak.", "bestemming": "Wonen", "plan_url": "https://www.ruimtelijkeplannen.nl/viewer/viewer?planidn=NL.IMRO.1234.BP1234", "bestemmingsvlak": { "id": "12345", "naam": "Wonen", "type": "bestemmingsvlak", "bestemmingshoofdgroep": "Wonen", "artikelnummer": "3.1", "verwijzingNaarTekst": [ "Artikel 3 Wonen" ] }, "documenten": [], "copyright": "Gegevens geleverd door Digitaal Stelsel Omgevingswet (DSO-LV) onder CC-BY licentie." } } ], "properties": { "found": { "type": "boolean" }, "address": { "type": [ "object", "null" ], "properties": { "bag_nummeraanduiding_id": { "type": [ "string", "null" ] }, "bag_verblijfsobject_id": { "type": [ "string", "null" ] }, "bag_pand_ids": { "type": "array", "items": { "type": "string" } }, "bag_openbare_ruimte_id": { "type": [ "string", "null" ] }, "bag_woonplaats_id": { "type": [ "string", "null" ] }, "street": { "type": [ "string", "null" ] }, "short_name": { "type": [ "string", "null" ] }, "house_number": { "type": [ "integer", "null" ] }, "house_letter": { "type": [ "string", "null" ] }, "house_number_addition": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "municipality": { "type": [ "string", "null" ] }, "address_line": { "type": [ "string", "null" ] }, "address_line_postal": { "type": [ "string", "null" ] }, "usage_purposes": { "type": "array", "items": { "type": "string" } }, "surface_area_m2": { "type": [ "integer", "null" ] }, "build_year": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "is_secondary_address": { "type": "boolean" }, "is_observed": { "type": [ "boolean", "null" ] }, "in_investigation": [], "document_date": { "type": [ "string", "null" ] }, "document_number": { "type": [ "string", "null" ] }, "secondary_address_ids": { "type": "array", "items": { "type": "string" } }, "occurrence": [], "lat": { "type": [ "number", "null" ] }, "lon": { "type": [ "number", "null" ] } }, "required": [ "bag_nummeraanduiding_id", "bag_verblijfsobject_id", "bag_pand_ids", "bag_openbare_ruimte_id", "bag_woonplaats_id", "street", "short_name", "house_number", "house_letter", "house_number_addition", "postcode", "city", "municipality", "address_line", "address_line_postal", "usage_purposes", "surface_area_m2", "build_year", "status", "type", "is_secondary_address", "is_observed", "in_investigation", "document_date", "document_number", "secondary_address_ids", "occurrence", "lat", "lon" ] }, "bag_identifiers": { "type": "object", "properties": { "nummeraanduiding_id": { "type": [ "string", "null" ] }, "verblijfsobject_id": { "type": [ "string", "null" ] }, "openbareruimte_id": { "type": [ "string", "null" ] } }, "required": [ "nummeraanduiding_id", "verblijfsobject_id", "openbareruimte_id" ] }, "energy_labels": { "type": "array", "items": { "type": "object", "additionalProperties": [] } }, "energy_label": { "type": [ "object", "null" ], "properties": { "label": { "type": [ "string", "null" ] }, "energy_class": { "type": [ "string", "null" ] }, "energy_index": { "type": [ "number", "null" ] }, "building_class": { "type": [ "string", "null" ] }, "building_type": { "type": [ "string", "null" ] }, "building_subtype": { "type": [ "string", "null" ] }, "construction_year": { "type": [ "integer", "null" ] }, "calculated_co2_emission": { "type": [ "number", "null" ] }, "calculated_energy_consumption": { "type": [ "number", "null" ] }, "registration_date": { "type": [ "string", "null" ] }, "valid_until": { "type": [ "string", "null" ] } }, "required": [ "label", "energy_class", "energy_index", "building_class", "building_type", "building_subtype", "construction_year", "calculated_co2_emission", "calculated_energy_consumption", "registration_date", "valid_until" ] }, "energy_details": { "type": [ "object", "null" ], "properties": { "recording": { "type": "object", "properties": { "recording_date": { "type": [ "string", "null" ] }, "recording_type": { "type": [ "string", "null" ] }, "certificate_holder": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "calculation_type": { "type": [ "string", "null" ] }, "is_simplified_label": { "type": [ "boolean", "null" ] }, "based_on_reference_building": { "type": [ "boolean", "null" ] } }, "required": [ "recording_date", "recording_type", "certificate_holder", "status", "calculation_type", "is_simplified_label", "based_on_reference_building" ] }, "energy_performance": { "type": "object", "properties": { "energy_index_emg_forfeit": { "type": [ "number", "null" ] }, "energy_demand": { "type": [ "number", "null" ] }, "primary_fossil_energy": { "type": [ "number", "null" ] }, "primary_fossil_energy_emg_forfeit": { "type": [ "number", "null" ] }, "renewable_energy_share": { "type": [ "number", "null" ] }, "renewable_energy_share_emg_forfeit": { "type": [ "number", "null" ] }, "temperature_overrun": { "type": [ "number", "null" ] }, "heat_demand": { "type": [ "number", "null" ] } }, "required": [ "energy_index_emg_forfeit", "energy_demand", "primary_fossil_energy", "primary_fossil_energy_emg_forfeit", "renewable_energy_share", "renewable_energy_share_emg_forfeit", "temperature_overrun", "heat_demand" ] }, "requirements": { "type": "object", "properties": { "energy_demand": { "type": [ "number", "null" ] }, "primary_fossil_energy": { "type": [ "number", "null" ] }, "renewable_energy_share": { "type": [ "number", "null" ] }, "temperature_overrun": { "type": [ "number", "null" ] } }, "required": [ "energy_demand", "primary_fossil_energy", "renewable_energy_share", "temperature_overrun" ] }, "bag_building_ids": { "type": "array", "items": { "type": "string" } }, "sbi_code": { "type": [ "string", "null" ] }, "detail_description": { "type": [ "string", "null" ] } }, "required": [ "recording", "energy_performance", "requirements", "bag_building_ids", "sbi_code", "detail_description" ] }, "property_value": { "type": [ "object", "null" ], "properties": { "amount": { "type": [ "integer", "null" ] }, "reference_date": { "type": [ "string", "null" ] }, "history": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": [ "integer", "null" ] }, "reference_date": { "type": [ "string", "null" ] } }, "required": [ "amount", "reference_date" ] } } }, "required": [ "amount", "reference_date", "history" ] }, "building": { "type": [ "object", "null" ], "properties": { "surface_area": { "type": [ "integer", "null" ] }, "construction_year": { "type": [ "integer", "null" ] }, "type": { "type": [ "string", "null" ] }, "subtype": { "type": [ "string", "null" ] }, "class": { "type": [ "string", "null" ] }, "compactness": { "type": [ "number", "null" ] } }, "required": [ "surface_area", "construction_year", "type", "subtype", "class", "compactness" ] }, "spatial_planning": { "type": [ "object", "null" ], "additionalProperties": [] }, "environmental_info": { "type": [ "object", "null" ], "additionalProperties": [] } }, "required": [ "found" ] } } } }, "422": { "$ref": "#/components/responses/ValidationException" }, "404": { "description": "Property not found", "content": { "application/json": { "schema": { "type": "object", "examples": [ { "found": false } ], "properties": { "found": { "type": "boolean" } }, "required": [ "found" ] } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-Api-Key" }, "BearerAuth": { "type": "http", "scheme": "bearer" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } } } } }