Endpoint

Adressen

Alle treffers op een postcode en huisnummer, inclusief huisletters en toevoegingen, met bouwjaar, oppervlakte en gebruiksdoel.

Het verzoek

GET /v1/addresses

Alle treffers op een postcode en huisnummer, inclusief letters en toevoegingen.

Parameter	Type	Verplicht	Omschrijving
`postcode`	string	ja	P6 zonder spatie.
`number`	integer	nee	Huisnummer. Zonder nummer krijg je de hele postcode terug.
`letter`	string	nee	Huisletter, één teken.
`addition`	string	nee	Huisnummertoevoeging.

De response

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

200 application/json

{
  "data": [
    {
      "id": "0363200012101386",
      "postcode": "1021JT",
      "number": 19,
      "letter": null,
      "addition": null,
      "street": "Hamerstraat",
      "city": "Amsterdam",
      "municipality": "Amsterdam",
      "province": "Noord-Holland",
      "location": { "type": "Point", "coordinates": [4.92204151, 52.38488658] },
      "purposes": ["woonfunctie"],
      "surface": 98,
      "constructionYear": 1930,
      "type": "verblijfsobject"
    }
  ]
}

Velden in een adresobject

Veld	Type	Omschrijving
`id`	string	BAG-nummeraanduiding, zestien cijfers. Uniek per adres.
`postcode`	string	P6 zonder spatie, hoofdletters.
`number`	integer	Huisnummer zonder letter of toevoeging.
`letter`	string\|null	Huisletter, één teken. `null` als het adres er geen heeft.
`addition`	string\|null	Huisnummertoevoeging. `null` als het adres er geen heeft.
`street`	string	Naam van de openbare ruimte uit de BAG.
`city`	string	BAG-woonplaats. Dit is niet altijd de gemeente.
`municipality`	string	Gemeente waaronder de woonplaats valt.
`province`	string	Provincie.
`location`	object\|null	GeoJSON-punt met `[longitude, latitude]`. `null` bij een postbus.
`purposes`	array	Gebruiksdoelen uit de BAG, bijvoorbeeld `["woonfunctie"]`.
`surface`	integer\|null	Oppervlakte van het verblijfsobject in vierkante meters.
`constructionYear`	integer\|null	Bouwjaar van het pand.
`type`	string	Objecttype, bijvoorbeeld `verblijfsobject`, `ligplaats`, `standplaats` of `postbus`.

Voorbeelden

curl -sS \
  -H "X-Api-Key: lat_test_demo_publiek_locatieapi_sandbox" \
  -H "Accept: application/json" \
  "https://api.locatieapi.nl/v1/addresses?postcode=1021JT&number=19"

$curl = curl_init('https://api.locatieapi.nl/v1/addresses?postcode=1021JT&number=19');
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/addresses?postcode=1021JT&number=19');

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

const response = await fetch('https://api.locatieapi.nl/v1/addresses?postcode=1021JT&number=19', {
  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/addresses?postcode=1021JT&number=19",
    headers={"X-Api-Key": "lat_test_demo_publiek_locatieapi_sandbox", "Accept": "application/json"},
    timeout=5,
)

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

Zoeken op een letter of toevoeging

Combineer number met letter of addition om één specifiek adres te krijgen. Laat je ze weg, dan krijg je alle adressen op dat huisnummer terug, gesorteerd op letter en toevoeging.

Eén adres op BAG-id

GET /v1/addresses/{bagId}

Heb je het BAG-id al, bijvoorbeeld omdat je het bij een eerdere aanroep hebt opgeslagen, dan haal je het adres daar rechtstreeks mee op. Dat is de stabielste sleutel: een postcode kan wijzigen, een nummeraanduiding niet.

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

$curl = curl_init('https://api.locatieapi.nl/v1/addresses/0363200012101386');
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/addresses/0363200012101386');

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

const response = await fetch('https://api.locatieapi.nl/v1/addresses/0363200012101386', {
  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/addresses/0363200012101386",
    headers={"X-Api-Key": "lat_test_demo_publiek_locatieapi_sandbox", "Accept": "application/json"},
    timeout=5,
)

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