/bagSearch BAG addresses by postcode, house number or public-space name, with sorting and pagination.
GET /bag — paginated BAG address and postcode search.
{
"properties": {
"fields[]": {
"description": "Additional result field; may be repeated by raw callers.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"filters[huisnummer]": {
"description": "Exact house-number filter.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"filters[openbareruimtenaam]": {
"description": "Exact public-space or street-name filter.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"filters[postcode]": {
"description": "Exact Dutch postcode filter.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"order": {
"description": "Sort order, asc or desc.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"page": {
"description": "Page number; default 1.",
"required": false,
"type": "integer",
"x-parameter-location": "query"
},
"query": {
"description": "Address, street or postcode search value; wildcards are supported.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"queryfields": {
"description": "Field searched by query, for example openbareruimtenaam or postcode.",
"required": false,
"type": "string",
"x-parameter-location": "query"
},
"size": {
"description": "Results per page; default 100.",
"required": false,
"type": "integer",
"x-parameter-location": "query"
},
"sort": {
"description": "Field to sort by.",
"required": false,
"type": "string",
"x-parameter-location": "query"
}
},
"type": "object"
}{
"properties": {
"_embedded": {
"properties": {
"adres": {
"items": {
"properties": {
"_links": {
"type": "object"
},
"huisletter": {
"type": "string"
},
"huisnummer": {
"type": "string"
},
"openbareruimte": {
"type": "string"
},
"postcode": {
"type": "string"
},
"slug": {
"type": "string"
},
"woonplaats": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"_links": {
"type": "object"
},
"pageCount": {
"type": "integer"
},
"size": {
"type": "integer"
},
"totalItemCount": {
"type": "integer"
}
},
"required": [
"totalItemCount",
"pageCount",
"size",
"_embedded"
],
"type": "object"
}{
"filters[postcode]": "3015BA",
"size": 1
}{
"_embedded": {
"adres": [
{
"huisletter": "C",
"huisnummer": "10",
"openbareruimte": "Nieuwe Binnenweg",
"postcode": "3015BA",
"slug": "3015ba-nieuwe-binnenweg-10-c",
"woonplaats": "Rotterdam"
}
]
},
"pageCount": 110,
"size": 1,
"totalItemCount": 110
}