API docs by RedoclyPostcode API (3.0.0)
Download OpenAPI specification:Download
This is the API reference of Postcode API (version 3). The API currently only supports the lookup function in order to retreive the street and city belonging to a given postcode and number. If you are looking for more information about this API, SDK's or plugins (e.g. for Wordpress), be sure to check out our documentation page (Dutch only) at https://www.postcodeapi.nu/docs.
The base URI of the production API is https://api.postcodeapi.nu/v3. Requests to this API can only be made with a valid API key belonging to a paid subscription. Every request made to this API will be deducted from your subscription limits. For testing and development purposes we strongly advise to use the Sandbox API instead.
The base URI of the sandbox API https://sandbox.postcodeapi.nu/v3. Requests to this API can be made with a valid API key belonging to a paid subscription or with a free sandbox API key. Requests made to this API do not affect your subscription limits. The sandbox API is identical to the production API, but it only returns a couple of addresses. Therefore, it makes no sense to use the sandbox API in your production environment. Valid postcode/number combinations are listed in the table below.
| Postcode | Number | Testcase |
|---|---|---|
| 6545CA | 29 | 200 OK, address found: Waldeck Pyrmontsingel, Nijmegen, Gelderland |
| 1021JT | 19 | 200 OK, address found: Hamerstraat, Amsterdam, Noord-Holland |
| 5038EA | 17 | 200 OK, address found: Stationsstraat, Tilburg, Noord-Brabant |
| 3030AC | 100 | 200 OK, address found: Postbus, Leusden, Utrecht |
| 6545CA | 29a | 400 Bad request, invalid number format |
| 6545C | 29 | 400 Bad request, invalid postcode format |
| 6545C | 29a | 400 Bad request, invalid postcode and number format |
| 6545CA | 299 | 404 Not found, address not found |
Lookup
The lookup function returns the street, city, municipality, province and location belonging to the given postcode and number.
Authorizations:
path Parameters
| postcode required | string^[0-9]{4}[a-zA-Z]{2}$ Example: 6545CA Postcode in P6 format: 4 numbers followed by 2 letters without whitespaces (e.g. |
| number required | integer Example: 29 Number of the address. Must be an integer. Additions (like |
Responses
Response samples
- 200
- 400
- 401
- 404
{- "postcode": "6545CA",
- "number": 29,
- "street": "Binderskampweg",
- "city": "Nijmegen",
- "municipality": "Nijmegen",
- "province": "Gelderland",
- "location": {
- "type": "Point",
- "coordinates": [
- 5.858910083770752,
- 51.84376540294041
]
}
}