README

This package is a Laravel wrapper of Nationaal Georegister provider for Geocoder PHP, which can be used to lookup a postal code to return the corresponding street and city.

The publicly available PDOK Locatieserver v3 (Dutch) is utilized to provide the necessary geodata.

Installation

Use composer to install this package:

$ composer require chabter/laravel-dutch-postalcode-lookup

Usage

Perform a lookup by postal code:

PostalCodeLookupService::lookup('1012JS');

Or perform a lookup by a postal code and house number combination:

PostalCodeLookupService::lookup('1012JS', 1);

The lookup method also supports using house number extensions as follows:

PostalCodeLookupService::lookup('1012JS', '5B');

Response

The lookup method returns a Chabter\PostalCodeLookup\Models\Address model on success, for example:

$address->getPostalCode() => '1012JS';
$address->getHouseNumber() => 1; // or string including housenumber extension
$address->getStreet() => 'Dam';
$address->getCity() => 'Amsterdam';
$address->getCoordinates() => [ latitude: 0.0000, longitude: 0.0000 ];

Testing

Run the tests with:

$ composer test

Support

Version 1.x will also work with Laravel 8 if Guzzle 6 is available (^6.5|7.0 in composer.json).

Postcardware

This package is completely free to use. If it makes it to your production environment we would highly appreciate you sending us a postcard from your hometown! 👏🏼

Our address is: CBYTE Software B.V., Parallelweg 27, 5223AL 's-Hertogenbosch, Netherlands.

License

The MIT License (MIT). Please see License File for more information.