{"openapi":"3.1.0","info":{"title":"BAG API Kadaster (BYOK) API","version":"0.1.0","description":"BAG API Kadaster (BYOK) lets an AI assistant read your own BAG API Kadaster data through the BAG API Kadaster API with a key you supply (BAG API key). Read-only: 9 tools (search_addresses, get_address, get_addressable_object, search_addressable_objects_in_bbox, get_dwelling, list_dwellings_in_building, get_building, get_public_space, get_residence_place). The BYOK key travels with each request,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-bagkadaster.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-bagkadaster/docs"},"termsOfService":"https://connectorbay.com/byok-bagkadaster/terms"},"servers":[{"url":"https://byok-bagkadaster.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-bagkadaster/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/search_addresses":{"post":{"operationId":"search_addresses","summary":"Search current Dutch addresses by postcode and house number (optionally house letter); returns street, number, postcode,","description":"Search current Dutch addresses by postcode and house number (optionally house letter); returns street, number, postcode, place and object identifiers. Use for \"What address is at postcode 2631CR number 15c\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"postcode":{"description":"Dutch postcode without space, for example '2631CR'.","maxLength":7,"title":"Postcode","type":"string"},"huisnummer":{"anyOf":[{"maximum":99999,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"House number.","title":"Huisnummer"},"huisletter":{"anyOf":[{"maxLength":2,"type":"string"},{"type":"null"}],"default":null,"description":"House letter, for example 'c'.","title":"Huisletter"},"exacte_match":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to return only the exact house number, letter and addition given.","title":"Exacte Match"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (10 to 100).","title":"Page Size"}},"required":["postcode"],"title":"search_addressesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_address":{"post":{"operationId":"get_address","summary":"Get one address by its nummeraanduiding identification number. Use for \"Show the address with identification 19262000005","description":"Get one address by its nummeraanduiding identification number. Use for \"Show the address with identification 1926200000508011\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"identificatie":{"description":"Nummeraanduiding (address) identification number (16 digits), for example '1926200000508011'.","maxLength":200,"title":"Identificatie","type":"string"}},"required":["identificatie"],"title":"get_addressArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_addressable_object":{"post":{"operationId":"get_addressable_object","summary":"Get a dwelling, berth or mooring spot (adresseerbaar object) with its address, use, area and status by identification nu","description":"Get a dwelling, berth or mooring spot (adresseerbaar object) with its address, use, area and status by identification number. Use for \"What is addressable object 0599010000165822 used for and how large is it\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"identificatie":{"description":"Addressable object identification number (16 digits), for example '0599010000165822'.","maxLength":200,"title":"Identificatie","type":"string"}},"required":["identificatie"],"title":"get_addressable_objectArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_addressable_objects_in_bbox":{"post":{"operationId":"search_addressable_objects_in_bbox","summary":"List addressable objects (with addresses) inside a bounding box given in Dutch RD coordinates (EPSG:28992); the box may ","description":"List addressable objects (with addresses) inside a bounding box given in Dutch RD coordinates (EPSG:28992); the box may cover at most 250,000 square metres. Use for \"Which addressable objects are inside bbox 230781.67,582665.17,230956.35,582882.42\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"bbox":{"description":"Lower-left x,y then upper-right x,y in RD metres, for example '230781.67,582665.17,230956.35,582882.42'.","maxLength":100,"title":"Bbox","type":"string"},"huidig":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True to return only current objects without an end status.","title":"Huidig"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (10 to 100).","title":"Page Size"}},"required":["bbox"],"title":"search_addressable_objects_in_bboxArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_dwelling":{"post":{"operationId":"get_dwelling","summary":"Get one verblijfsobject (dwelling or other usable unit) with purposes of use, floor area, status and the buildings it be","description":"Get one verblijfsobject (dwelling or other usable unit) with purposes of use, floor area, status and the buildings it belongs to. Use for \"Give me details of dwelling 0268010000036826\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"identificatie":{"description":"Dwelling (verblijfsobject) identification number (16 digits), for example '0268010000036826'.","maxLength":200,"title":"Identificatie","type":"string"}},"required":["identificatie"],"title":"get_dwellingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_dwellings_in_building":{"post":{"operationId":"list_dwellings_in_building","summary":"List all dwellings (verblijfsobjecten) in one building (pand) with their use, area and status. Use for \"Which dwellings ","description":"List all dwellings (verblijfsobjecten) in one building (pand) with their use, area and status. Use for \"Which dwellings are in building 0268100000021458\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"pand_identificatie":{"description":"Building (pand) identification number, for example '0268100000021458'.","maxLength":16,"title":"Pand Identificatie","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"Results per page (10 to 100).","title":"Page Size"}},"required":["pand_identificatie"],"title":"list_dwellings_in_buildingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_building":{"post":{"operationId":"get_building","summary":"Get one building (pand) record by identification number. Use for \"Show the record of building 0826100000000467\".","description":"Get one building (pand) record by identification number. Use for \"Show the record of building 0826100000000467\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"identificatie":{"description":"Building (pand) identification number (16 digits), for example '0826100000000467'.","maxLength":200,"title":"Identificatie","type":"string"}},"required":["identificatie"],"title":"get_buildingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_public_space":{"post":{"operationId":"get_public_space","summary":"Get one public space (openbare ruimte, such as a street) by identification number. Use for \"What is public space 1926300","description":"Get one public space (openbare ruimte, such as a street) by identification number. Use for \"What is public space 1926300000479027\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"identificatie":{"description":"Public space (openbare ruimte) identification number (16 digits), for example '1926300000479027'.","maxLength":200,"title":"Identificatie","type":"string"}},"required":["identificatie"],"title":"get_public_spaceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_residence_place":{"post":{"operationId":"get_residence_place","summary":"Get one place of residence (woonplaats, a town or village) by its identification number. Use for \"Which place is woonpla","description":"Get one place of residence (woonplaats, a town or village) by its identification number. Use for \"Which place is woonplaats 1142\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"identificatie":{"description":"Woonplaats identification number, for example '1142'.","maxLength":200,"title":"Identificatie","type":"string"}},"required":["identificatie"],"title":"get_residence_placeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}