PostcodesIO is a PHP library for postcodes.io API.
Install using composer:
$ composer require jabranr/postcodes-io
All of the following methods returnn back the same complete response as it comes from postcodes.io API in JSON format.
Use
try, catch
to make requests and capture exceptions in case of failure.
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->find('NW1 5LD');
$postcodeFinder = new PostcodesIO('NW1 5LD');
$addresses = $postcodeFinder->getResult();
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findByLocation(51.520331, -0.1396267);
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findRandom();
OR use the alias method:
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->random();
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->validate('NW1 5LD');
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findNearest('NW1 5LD');
OR use the alias method:
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->nearest();
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->autocomplete('NW1');
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->query('NW1 5LD');
OR use the alias method:
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->search('NW1 5LD');
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findOutcode('NW1');
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->nearestOutcode('NW1');
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findOutcodeByLocation(51.520331, -0.1396267);
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->bulkPostcodeSearch(array('NW1 5LD', 'W1T 7NY'));
Maximum of 100 postcodes per request.
$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->bulkReverseGeocoding(array(
array(51.520331, -0.1396267),
array(51.520331, -0.1396267)
));
Maximum of 100 geolocations per request.
MIT License ยฉ 2016 โ Jabran Rafique