Code Monkey home page Code Monkey logo

postcodes-io's Introduction

PostcodesIO Build Status

PostcodesIO is a PHP library for postcodes.io API.

Install

Install using composer:

$ composer require jabranr/postcodes-io

Documentation

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.

Find postcode information

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->find('NW1 5LD');
$postcodeFinder = new PostcodesIO('NW1 5LD');
$addresses = $postcodeFinder->getResult();

Find postcode information by geo location

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findByLocation(51.520331, -0.1396267);

Find random postcode information

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findRandom();

OR use the alias method:

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->random();

Validate a postcode

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->validate('NW1 5LD');

Find nearest postcodes

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findNearest('NW1 5LD');

OR use the alias method:

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->nearest();

Get an autocompleted list of a postcode/outcode

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->autocomplete('NW1');

Search a postcode

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->query('NW1 5LD');

OR use the alias method:

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->search('NW1 5LD');

Find an outcode

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findOutcode('NW1');

Find nearest outcodes

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->nearestOutcode('NW1');

Find an outcode by location

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->findOutcodeByLocation(51.520331, -0.1396267);

Bulk postcodes search

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->bulkPostcodeSearch(array('NW1 5LD', 'W1T 7NY'));

Maximum of 100 postcodes per request.

Bulk reverse geocoding

$postcodeFinder = new PostcodesIO();
$addresses = $postcodeFinder->bulkReverseGeocoding(array(
    array(51.520331, -0.1396267),
    array(51.520331, -0.1396267)
));

Maximum of 100 geolocations per request.

License

MIT License ยฉ 2016 โ€“ Jabran Rafique

postcodes-io's People

Contributors

jabranr avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.