A PHP client to talk to the REST API of Postcode.nl.
Switch branches/tags
Nothing to show
Clone or download
MaartenScholder Call newer API which returns streetNen, cityShort and municipalitySho…
…rt fields.

- Request rest/addresses/postcode which returns streetNen, cityShort and municipalityShort fields.
- Updated and extended documentation of returned fields, see https://api.postcode.nl/documentation for latest info.
- index.php : Documented an example of a shorter streetNen of a long street.
- Minimum PHP 5.6. See http://php.net/eol.php, earlier versions haven't been supported by PHP for over a year.
Latest commit 8eb69b4 Oct 9, 2017


Postcode.nl API REST Client

A PHP 5.6+ class, which offers methods to directly talk with the Postcode.nl API through the REST endpoint offered. You will need to create an account with the Postcode.nl API service.


The code is available under the open source Simplified BSD license. (see LICENSE.txt)


The best way to install is by using PHP Composer, get package postcode-nl/api-restclient and stay up to date easily.

Or download the source from our GitHub page: https://github.com/postcode-nl/PostcodeNl_Api_RestClient

Usage Address API

Include the class in your PHP project, instantiate the PHP class with your authentication details and call the 'lookupAddress' method. You can handle errors by catching the defined Exception classes. (See the 'library/PostcodeNl/Api/RestClient.php' file for details on which exceptions can be thrown)

	require_once '/PATH/TO/library/PostcodeNl/Api/RestClient.php';
	$client = new PostcodeNl_Api_RestClient('{your key}', '{your secret}');

	// Look up the address for Dutch postcode 2012ES, housenumber 30,
	// with no housenumber addition.
		$address = $client->lookupAddress('2012ES', '30', '');
	catch (PostcodeNl_Api_RestClient_AddressNotFoundException $e)
		die('There is no address on this postcode/housenumber combination: '. $e);
	catch (PostcodeNl_Api_RestClient_InputInvalidException $e)
		die('We have input which can never return a valid address: '. $e);
	catch (PostcodeNl_Api_RestClient_ClientException $e)
		die('We have a problem setting up our client connection: '. $e);
	catch (PostcodeNl_Api_RestClient_AuthenticationException $e)
		die('The Postcode.nl API service does not know who we are: '. $e);
	catch (PostcodeNl_Api_RestClient_ServiceException $e)
		die('The Postcode.nl API service reported an error: '. $e);

	// Print the address data
	echo var_export($address, true);