/cities (Woonplaatsen)

Haal alle woonplaatsen op die aan een bepaalde zoekopdracht voldoen.

https://api.adresdata.net/cities

Request parameters

Alle parameters zijn optioneel.

Voorbeeld request

https://api.adresdata.net/cities?include=municipality,province&containing=52.1551985,5.3866942&geometry=wgs84

name

Filter op een bepaalde woonplaats naam. Alleen exacte matches worden teruggegeven.

include

Kommagescheiden lijst met namen van objecten die je per woonplaats erbij wilt hebben in het response. Kan één of meer van de volgende namen zijn:
- municipality de gemeente
- province de provincie (Werkt alleen i.c.m. municipality)

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.

containing

Geef alleen woonplaatsen terug waar het meegegeven coördinaat zich in bevindt. In praktijk zal dit de resultset meestal beperken tot één resultaat. De X en Y coördinaten (of latitude en longitude) moeten gescheiden zijn met een komma.

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 de woonplaats.

name

Naam van de woonplaats.

postcodeAreas

Alle 4-cijferige postcodes die binnen deze woonplaats gebruikt worden.

Voorbeeld response

{
    "result": [
        {
            "id": "1664",
            "name": "Amersfoort",
            "postcodeAreas": [
                "3811",
                "3812",
                "3813",
                "3814",
                "3815",
                "3816",
                "3817",
                "3818",
                "3819",
                "3821",
                "3822",
                "3823",
                "3824",
                "3825",
                "3826"
            ],
            "municipality": {
                "id": "0307",
                "name": "Amersfoort",
                "province": {
                    "name": "Utrecht"
                }
            }
        }
    ]
}