API Documentatie

/addresses (Adresgegevens)

Haal alle addressen op die aan een bepaalde zoekopdracht voldoen.

https://api.adresdata.net/addresses

Request parameters

Alle parameters zijn optioneel.

Voorbeeld request
https://api.adresdata.net/addresses?near=52.1551985,5.3866942&include=city,municipality,province&geometry=wgs84&limit=1
postcode
Filter op een specifieke postcode. (4 cijfers + 2 letters)
number.full
Filter op een specifiek huisnummer.
street.name
Filter op een bepaalde straatnaam. Alleen exacte matches worden teruggegeven.
street.id
Filter op een specifiek straat id. (Basispakket of hoger)
include
Kommagescheiden lijst met namen van objecten die je per adres erbij wilt hebben in het response. Kan één of meer van de volgende namen zijn:
- city de woonplaats waarin het adres zich bevindt.
- municipality de gemeente (Werkt alleen i.c.m. city)
- province de provincie (Werkt alleen i.c.m. municipality)
city.name
Filter op een bepaalde woonplaats naam. Alleen exacte matches worden teruggegeven. Werkt alleen wanneer city in de include staat.
municipality.name
Filter op een bepaalde gemeente naam. Alleen exacte matches worden teruggegeven. Werkt alleen wanneer municipality in de include staat.
province.name
Filter op een bepaalde provincie naam. Alleen exacte matches worden teruggegeven. Werkt alleen wanneer province in de include staat.
near
Sorteer de resultaten op afstand tot de meegegeven coördinaten. Alleen adressen binnen een straal van 1 km worden teruggegeven. De X en Y coördinaten (of latitude en longitude) moeten gescheiden zijn met een komma. Indien deze parameter aanwezig is krijgt elk resultaat een extra veld: distance. Dit is de afstand tot het opgegeven coördinaat in meters.
geometry
Naam van het coördinatenstelsel waarin geometrische objecten worden teruggegeven. Kan één van deze waarden zijn:
- rd (standaard)
- wgs84
Voor meer informatie zie: Coördinaten & geometrie.
limit
Maximum aantal resultaten dat teruggegeven mag worden.
Standaard: 25
Minimum: 1
Maximum: 100
offset
Aantal resultaten dat overgeslagen moet worden.
Standaard: 0
Minimum: 0
Maximum: 10

Response velden

id
ID van het adres.
number.full
Volledige huisnummer: cijfers + letter + toevoeging.
number.digits
De cijfers van het huisnummer. (Basispakket of hoger)
number.letter
De letter van het huisnummer. (Basispakket of hoger)
number.suffix
De toevoeging van het huisnummer. (Basispakket of hoger)
postcodeArea
De eerste 4 cijfers van de postcode.
postcode
Volledige postcode.
street.id
ID van de straat. (Basispakket of hoger)
street.name
Straatnaam.
status
Status van het verblijfsobject gekoppeld aan dit adres. Kan één van de volgende waarden zijn:
- under_construction Een nieuw verblijfsobject dat deel gaat uitmaken van een nog niet gebouwd pand waarvoor een bouwvergunning is verleend of dat wordt gerealiseerd in een reeds bestaand pand.
- to_be_surveyed Een verblijfsobject waarvan de aanvrager van de bouwvergunning heeft gemeld dat de bouw is voltooid of waarvan in een schriftelijke verklaring van een daartoe bevoegd ambtenaar is vastgesteld dat het verblijfsobject feitelijk in gebruik is genomen voor bijvoorbeeld bewoning dan wel bedrijfsuitoefening of dat het weliswaar (nog) niet in gebruik is genomen maar naar het oordeel van de gemeente wel gebruiksgereed is.
- in_use Een verblijfsobject dat feitelijk de status to_be_surveyed had en waarvan de definitieve geometrie is ingemeten.
- out_of_use Een verblijfsobject dat onderdeel uitmaakt van een pand dat in dusdanige bouwkundige staat is dat niet te verwachten is dat het pand zal worden hersteld en weer in gebruik zal worden genomen.
purposes
Gebruiksdoelen van de objecten op dit adres. Kan één of meer van de volgende waarden zijn:
- residence Wonen
- gathering Bijeenkomstfunctie (voor bijvoorbeeld: kunst, cultuur, godsdienst, communicatie, kinderopvang)
- penitentiary Cel/gevangenis, voor dwangverblijf van mensen
- healthcare Gezondheidszorg (voor bijvoorbeeld: medisch onderzoek, verpleging, verzorging of behandeling)
- industry Industrie
- office Kantoor
- accommodation Overnachten; het bieden van recreatief verblijf of tijdelijk onderdak aan mensen
- education Onderwijs
- sports Sport
- store Winkel
- other Een overig gebruiksdoel, waarbij het verblijven van mensen een ondergeschikte rol speelt.
location
Coördinaten van het adres.
floorArea
Gebruiksoppervlakte (GO) zoals beschreven in NEN 2580.
distance
Afstand tot het opgegeven coördinaat in meters. Dit veld is alleen aanwezig indien de near request parameter is ingevuld.
Voorbeeld response
{
    "result": [
        {
            "id": "0307200000533914",
            "number": {
                "full": "19",
                "digits": "19",
                "letter": null,
                "suffix": null
            },
            "postcodeArea": "3811",
            "postcode": "3811BA",
            "street": {
                "id": "0307300000307073",
                "name": "Westsingel"
            },
            "status": "in_use",
            "purposes": [
                "other"
            ],
            "location": [
                52.155145637755759,
                5.3865568710500185
            ],
            "floorArea": 18,
            "distance": 11.09,
            "city": {
                "id": "1664",
                "name": "Amersfoort",
                "municipality": {
                    "id": "0307",
                    "name": "Amersfoort",
                    "province": {
                        "name": "Utrecht"
                    }
                }
            }
        }
    ]
}