README

Laravel Postcode lookup integration

UK postcode lookup service provider for Laravel and Lumen. Uses Postcode Client to enable lookups using Ideal Postcodes.

Note that this service provider caches lookups indefinitely, since they don't change too often, but you may want to clear the cache from time to time. To do this, flush the postcodes tag.

Installation for Laravel

This package is only intended for Laravel 5.5 and up. Install it with the following command:

$ composer require matthewbdaly/laravel-postcodes

Then publish the config file:

$ php artisan vendor:publish

And add your API key to the .env file:

IDEAL_POSTCODES_API_KEY=foo