API

Address.view

Get an address based on its unique combination of postcode, houseNumber and house number addition. Coordinate and surfaceArea values are null values if no location is known, i.e. if the address is a PO Box.

Example REST request

Retrieving /rest/addresses/2012ES/30 with the proper authentication would use the following HTTP Request:

GET /rest/addresses/2012ES/30/ HTTP/1.1
Host: api.postcode.nl
Authorization: Basic 2eTpkU******…

Parameters

postcode:
string
Four number neighborhood code plus two character letter combination
houseNumber:
int
House number, within a range of 1 to 99999.
houseNumberAddition:
string
Addition to the house number, required to uniquely define an address with multiple additions.

Example response

This address exists, so we return a '200 OK' status in the headers, and json encoded data in the response body:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 410

{
  "street": "Julianastraat",
  "houseNumber": 30,
  "houseNumberAddition": "",
  "postcode": "2012ES",
  "city": "Haarlem",
  "municipality": "Haarlem",
  "province": "Noord-Holland",
  "rdX": 103242,
  "rdY": 487716,
  "latitude": 52.37487801,
  "longitude": 4.62714526,
  "bagNumberDesignationId": "0392200000029398",
  "bagAddressableObjectId": "0392010000029398",
  "addressType": "building",
  "purposes": [
	"office"
  ],
  "surfaceArea": 643,
  "houseNumberAdditions": [
	""
  ]
}

Returns

street:
string
Street name in accordance with "BAG (Basisregistraties adressen en gebouwen)". In capital and lowercase letters, including punctuation marks and accents. This field is at most 80 characters in length. Filled with "Postbus" in case it is a range of PO boxes.
houseNumber:
int
House number of a perceel. In case of a Postbus match the house number will always be 0. Range: 0-99999
houseNumberAddition:
string
Addition of the house number to uniquely define a location. These additions are officially recognized by the municipality. Null if addition not found (see houseNumberAdditions result field).
postcode:
string
Four number neighborhood code (first part of a postcode). Range: 1000-9999 plus two character letter combination (second part of a postcode). Range: "AA"-"ZZ"
city:
string
Official city name in accordance with "BAG (Basisregistraties adressen en gebouwen)". In capital and lowercase letters, including punctuation marks and accents. This field is at most 80 characters in length.
municipality:
string
Municipality name in accordance with "BAG (Basisregistraties adressen en gebouwen)". In capital and lowercase letters, including punctuation marks and accents. This field is at most 80 characters in length. Examples: "Baarle-Nassau", "'s-Gravenhage".
province:
string
Official name of the province, correctly cased and with dashes where applicable.
rdX:
int
X coordinate according to Dutch Rijksdriehoeksmeting "(EPSG) 28992 Amersfoort / RD New". Values range from 0 to 300000 meters. Null for PO Boxes.
rdY:
int
Y coordinate according to Dutch Rijksdriehoeksmeting "(EPSG) 28992 Amersfoort / RD New". Values range from 300000 to 620000 meters. Null for PO Boxes.
latitude:
double
Latitude of address. Null for PO Boxes.
longitude:
double
Longitude of address. Null for PO Boxes.
bagNumberDesignationId:
string
Dutch term used in BAG: "nummeraanduiding id".
bagAddressableObjectId:
string
Dutch term used in BAG: "adresseerbaar object id". Unique identification for objects which have 'building', 'house boat site', or 'mobile home site' as addressType.
addressType:
string
Type of this address. See reference for possible values.
purposes:
array of strings
List of all purposes (Dutch: "gebruiksdoelen"). Null or an array of text values. See reference for possible values.
surfaceArea:
int
Surface in square meters. Null for PO Boxes.
houseNumberAdditions:
array of strings
List of all house number additions having the postcode and houseNumber which was input.

References