BAG adres & postcode API documentatie

GET	`https://api.overheid.io/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://api.overheid.io/bag?filters[postcode]=3015BA

{
    "totalItemCount": 109,
    "pageCount": 2,
    "size": 100,
    "_links": {
        "first": {
            "href": "/bag?filters[postcode]=3015BA&page=1"
        },
        "last": {
            "href": "/bag?filters[postcode]=3015BA&page=10"
        },
        "next": {
            "href": "/bag?filters[postcode]=3015BA&page=2"
        },
        "self": {
            "href": "/bag?filters%5Bpostcode%5D=3015BA"
        }
    },
    "_embedded": {
        "adres": [{
                "_links": {
                    "self": {
                        "href": "/bag/3015ba-nieuwe-binnenweg-2"
                    }
                },
                "huisletter": "",
                "huisnummer": "2",
                "huisnummertoevoeging": "",
                "openbareruimte": "Nieuwe Binnenweg",
                "postcode": "3015BA",
                "slug": "3015ba-nieuwe-binnenweg-2",
                "woonplaats": "Rotterdam"
            },
            {
                "_links": {
                    "self": {
                        "href": "/bag/3015ba-nieuwe-binnenweg-10-f"
                    }
                },
                "huisletter": "F",
                "huisnummer": "10",
                "huisnummertoevoeging": "",
                "openbareruimte": "Nieuwe Binnenweg",
                "postcode": "3015BA",
                "slug": "3015ba-nieuwe-binnenweg-10-f",
                "woonplaats": "Rotterdam"
            },
            ...
        ]
    }
}

Zoek naar postcode en huisnummer in het overzicht.

https://api.overheid.io/bag?filters[postcode]=3015BA&filters[huisnummer]=10

Je kan met de wildcard (*) zoeken. Meerdere zijn mogelijk.

{
    "totalItemCount": 8,
    "pageCount": 1,
    "size": 100,
    "_links": {
        "self": {
            "href": "/bag?filters[postcode]=3015BA&filters[huisnummer]=10"
        }
    },
    "_embedded": {
        "adres": [{
                "huisletter": "E",
                "huisnummer": "10",
                "huisnummertoevoeging": "",
                "openbareruimtenaam": "Nieuwe Binnenweg",
                "postcode": "3015BA",
                "url": "3015ba-nieuwe-binnenweg-10-e",
                "woonplaatsnaam": "Rotterdam",
                "_links": {
                    "self": {
                        "href": "/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": "/bag/3015ba-nieuwe-binnenweg-10-a"
                    }
                }
            },
            ...
        ]
    }
}

GET	`https://api.overheid.io/bag/{bag_id}`

Geef alle informatie van een adres

https://api.overheid.io/bag/3015ba-nieuwe-binnenweg-10-a

{
    "_links": {
        "self": {
            "href": "/bag/3015ba-nieuwe-binnenweg-10-a?filters%5Bpostcode%5D=3015BA"
        }
    },
    "gemeente": "Rotterdam",
    "huisletter": "A",
    "huisnummer": "10",
    "huisnummertoevoeging": "",
    "locatie": {
        "lat": 51.9167095236329,
        "lon": 4.47216609904281
    },
    "nevenadres": "f",
    "object_id": 599010000160412,
    "openbareruimte": "Nieuwe Binnenweg",
    "oppervlakteverblijfsobject": 109,
    "pand_id": "0599100000755382",
    "pandbouwjaar": 1979,
    "pandstatus": "Pand in gebruik",
    "postcode": "3015BA",
    "provincie": "Zuid-Holland",
    "slug": "3015ba-nieuwe-binnenweg-10-a",
    "verblijfsobjectgebruiksdoel": "winkelfunctie",
    "verblijfsobjectstatus": "Verblijfsobject in gebruik",
    "woonplaats": "Rotterdam",
    "x": 92047.05,
    "y": 436865.24
}