Lookup | LocatieAPI

Het verzoek

GET /v3/lookup/{postcode}/{number}

Eén adres op postcode en huisnummer. Response-compatibel met postcodeapi.nu.

Parameter	Type	Verplicht	Omschrijving
`postcode`	string	ja	P6 zonder spatie, hoofdletters of kleine letters. Patroon `^[0-9]{4}[a-zA-Z]{2}$`.
`number`	integer	ja	Huisnummer als geheel getal. Een toevoeging in het pad geeft `400`, geen `404`.

De response

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

200 application/json

{
  "postcode": "1021JT",
  "number": 19,
  "street": "Hamerstraat",
  "city": "Amsterdam",
  "municipality": "Amsterdam",
  "province": "Noord-Holland",
  "location": {
    "type": "Point",
    "coordinates": [4.92204151, 52.38488658]
  }
}

Voorbeelden

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

$curl = curl_init('https://api.locatieapi.nl/v3/lookup/1021JT/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/v3/lookup/1021JT/19');

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

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

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

Fouten

Een toevoeging geeft 400, niet 404

/v3/lookup/6545CA/29a is een ongeldig verzoek: het huisnummer in het pad moet een geheel getal zijn. Je krijgt dus een 400 met een invalidParams-lijst. Wil je toevoegingen opzoeken, gebruik dan /v1/addresses.

400 application/problem+json

{
  "title": "Request validation failed",
  "invalidParams": [
    { "name": "number", "reason": "should be integer" }
  ]
}

404 application/problem+json

{
  "title": "Resource not found"
}

De volledige lijst met foutcodes staat op foutcodes.

Postbussen

Postbusreeksen staan niet in de BAG. Wij houden ze apart bij, zodat een postbusadres een nette 200 geeft in plaats van een 404. Bij een postbus is street letterlijk Postbus en is location gelijk aan null.

GET /v3/lookup/3030AC/100

{
  "postcode": "3030AC",
  "number": 100,
  "street": "Postbus",
  "city": "Leusden",
  "municipality": "Leusden",
  "province": "Utrecht",
  "location": null
}