Postcodes | LocatieAPI

Het verzoek

GET /v1/postcodes/{postcode}

Samenvatting per P6: straat, plaats, gemeente, provincie, zwaartepunt en aantal adressen.

Parameter	Type	Verplicht	Omschrijving
`postcode`	string	ja	P6 zonder spatie.

De response

Een geslaagde aanroep geeft 200 met Content-Type: application/json en Cache-Control: public, max-age=86400.

200 application/json

{
  "postcode": "1021JT",
  "street": "Hamerstraat",
  "city": "Amsterdam",
  "municipality": "Amsterdam",
  "province": "Noord-Holland",
  "location": { "type": "Point", "coordinates": [4.92204151, 52.38488658] },
  "addressCount": 64,
  "numberMin": 1,
  "numberMax": 121
}

Voorbeelden

curl -sS \
  -H "X-Api-Key: lat_test_demo_publiek_locatieapi_sandbox" \
  -H "Accept: application/json" \
  "https://api.locatieapi.nl/v1/postcodes/1021JT"

$curl = curl_init('https://api.locatieapi.nl/v1/postcodes/1021JT');
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 5,
    CURLOPT_HTTPHEADER => ['X-Api-Key: lat_test_demo_publiek_locatieapi_sandbox', 'Accept: application/json'],
]);

$body = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);

$result = $status === 200 ? json_decode($body, true) : null;

use Illuminate\Support\Facades\Http;

$response = Http::withHeaders(['X-Api-Key' => config('services.locatieapi.key')])
    ->acceptJson()
    ->timeout(5)
    ->get('https://api.locatieapi.nl/v1/postcodes/1021JT');

$result = $response->successful() ? $response->json() : null;

const response = await fetch('https://api.locatieapi.nl/v1/postcodes/1021JT', {
  headers: {
    'X-Api-Key': 'lat_test_demo_publiek_locatieapi_sandbox',
    Accept: 'application/json',
  },
});

const result = response.ok ? await response.json() : null;

import requests

response = requests.get(
    "https://api.locatieapi.nl/v1/postcodes/1021JT",
    headers={"X-Api-Key": "lat_test_demo_publiek_locatieapi_sandbox", "Accept": "application/json"},
    timeout=5,
)

result = response.json() if response.ok else None

Waar je dit voor gebruikt

•Een bezorggebied of servicegebied afbakenen op postcodeniveau, zonder alle losse adressen op te halen.
•Een kaartmarker plaatsen op het zwaartepunt van een postcode als je het huisnummer nog niet weet.
•Controleren of een ingevoerde postcode überhaupt bestaat, voordat je om een huisnummer vraagt.
•Het bereik van de huisnummers tonen, zodat je een gebruiker kunt waarschuwen bij een nummer dat er ver buiten valt.

Woonplaats en gemeente zijn niet hetzelfde

De BAG kent woonplaatsen die niet samenvallen met de gemeentegrens. Vlaardingen ligt in de gemeente Vlaardingen, maar Nieuw-Vennep ligt in de gemeente Haarlemmermeer. Gebruik city voor het adreslabel en municipality voor administratieve doelen.