| GET | https://overheid.io/api/bag |
Doorzoek de BAG dataset. De reponse bevat een lijst van adressen.
Parameters
| Naam |
Standaard waarde |
Omschrijving |
| size | 100 | Het aantal resultaten per pagina. |
| page | 1 | De gewenste pagina van resultaten. |
| sort | | sorteer veld. |
| order | desc | sorteer richting. |
| fields[] | - woonplaatsnaam
- huisletter
- huisnummer
- huisnummertoevoeging
- openbareruimtenaam
- postcode
- url
| Velden in het overzicht. |
| filters[] | Filter velden resulaten op termen. Dit is handig voor het filteren van vaste waardes, zoals bijvoorbeeld het merk. |
| query | | Zoek naar waarde. |
| queryfields | - openbareruimtenaam
- postcode
| Zoek naar waarde in deze velden. |
Voor de fields[] en filters[] array kun je alle veldnamen opgeven die in het details over een adres aanwezig zijn.
Voorbeelden
Zoek op postcode
https://overheid.io/api/bag?filters[postcode]=3015BA
{
"totalItemCount": 109,
"pageCount": 2,
"size": 100,
"_links": {
"self": {"href": "/api/bag?filters[postcode]=3015BA"},
"next": {"href": "/api/bag?filters[postcode]=3015BA&page=2"},
"first": {"href": "/api/bag?filters[postcode]=3015BA&page=1"},
"last": {"href": "/api/bag?filters[postcode]=3015BA&page=2"}
},
"_embedded": {"adres": [
{
"huisletter": "",
"huisnummer": "2",
"huisnummertoevoeging": "",
"openbareruimtenaam": "Nieuwe Binnenweg",
"postcode": "3015BA",
"url": "3015ba-nieuwe-binnenweg-2",
"woonplaatsnaam": "Rotterdam",
"_links": {"self": {"href": "/api/bag/3015ba-nieuwe-binnenweg-2"}}
},
{
"huisletter": "E",
"huisnummer": "10",
"huisnummertoevoeging": "",
"openbareruimtenaam": "Nieuwe Binnenweg",
"postcode": "3015BA",
"url": "3015ba-nieuwe-binnenweg-10-e",
"woonplaatsnaam": "Rotterdam",
"_links": {"self": {"href": "/api/bag/3015ba-nieuwe-binnenweg-10-e"}}
},
...
]}
}
Zoek naar postcode en huisnummer in het overzicht.
https://overheid.io/api/bag?filters[postcode]=3015BA&query=10&queryfields[]=huisnummer
Je kan met de wildcard (*) zoeken. Meerdere zijn mogelijk.
{
"totalItemCount": 8,
"pageCount": 1,
"size": 100,
"_links": {"self": {"href": "/api/bag?filters[postcode]=3015BA&query=10&queryfields[]=huisnummer"}},
"_embedded": {"adres": [
{
"huisletter": "E",
"huisnummer": "10",
"huisnummertoevoeging": "",
"openbareruimtenaam": "Nieuwe Binnenweg",
"postcode": "3015BA",
"url": "3015ba-nieuwe-binnenweg-10-e",
"woonplaatsnaam": "Rotterdam",
"_links": {"self": {"href": "/api/bag/3015ba-nieuwe-binnenweg-10-e"}}
},
{
"huisletter": "A",
"huisnummer": "10",
"huisnummertoevoeging": "",
"openbareruimtenaam": "Nieuwe Binnenweg",
"postcode": "3015BA",
"url": "3015ba-nieuwe-binnenweg-10-a",
"woonplaatsnaam": "Rotterdam",
"_links": {"self": {"href": "/api/bag/3015ba-nieuwe-binnenweg-10-a"}}
},
...
]}
}
| GET | https://overheid.io/suggest/bag/{query} |
Parameters
| Naam |
Standaard waarde |
Omschrijving |
| size | 10 | Het aantal resultaten per zoekopdracht,met en maximum van 25. |
| fields[] | - postcode
- provincienaam
- gemeentenaam
- woonplaatsnaam
- openbareruimtenaam
| Velden in het overzicht. |
Voorbeelden
Geeft suggesties voor de zoekterm. Handig voor autocomplete velden. De suggest houd rekening met spaties en andere tekens. Dus nieuw ve geeft dezelfde resultaten als nieuwve of nieuw-ve
https://overheid.io/suggest/bag/nieuwve
{
"woonplaatsnaam": [
{"text": "Nieuw-Vennep"},
{"text": "Nieuwveen"}
],
"openbareruimtenaam": [
{
"text": "Nieuwveld",
"extra": {
"id": "5702hw-nieuwveld-7",
"postcode": "5702HW"
}
},
{
"text": "Nieuwe Veenendaalseweg",
"extra": {
"id": "3911md-nieuwe-veenendaalseweg-1-a",
"postcode": "3911MD"
}
},
{
"text": "Nieuwveenseweg",
"extra": {
"id": "2421la-nieuwveenseweg-1",
"postcode": "2421LA"
}
},
{
"text": "Oude Nieuwveenseweg",
"extra": {
"id": "2441cr-oude-nieuwveenseweg-1",
"postcode": "2441CR"
}
},
{
"text": "Nieuwveens Jaagpad",
"extra": {
"id": "2441eh-nieuwveens-jaagpad-4",
"postcode": "2441EH"
}
},
{
"text": "Nieuwe Veer",
"extra": {
"id": "2959ak-nieuwe-veer-31",
"postcode": "2959AK"
}
},
{
"text": "Nieuwveenstraat",
"extra": {
"id": "2631at-nieuwveenstraat-4",
"postcode": "2631AT"
}
},
{
"text": "Nieuw Veldheim",
"extra": {
"id": "1402kx-nieuw-veldheim-1",
"postcode": "1402KX"
}
},
{
"text": "Nieuwe Veldjes",
"extra": {
"id": "7391bl-nieuwe-veldjes-15",
"postcode": "7391BL"
}
},
{
"text": "Nieuwe Veldenweg",
"extra": {
"id": "5464rc-nieuwe-veldenweg-1",
"postcode": "5464RC"
}
}
]
}