An open API service indexing awesome lists of open source software.

https://github.com/matthewbdaly/postcode-client

Postcode lookup client
https://github.com/matthewbdaly/postcode-client

php postcode uk

Last synced: 3 months ago
JSON representation

Postcode lookup client

Awesome Lists containing this project

README

        

# postcode-client

[![Build Status](https://travis-ci.org/matthewbdaly/postcode-client.svg?branch=master)](https://travis-ci.org/matthewbdaly/postcode-client)

Postcode lookup client. Uses [Ideal Postcodes](https://ideal-postcodes.co.uk/) to look up UK postcodes. You will need to obtain an API key in order to use it.

Installation
------------

```
composer require matthewbdaly/postcode-client
```

This library uses [HTTPlug](http://docs.php-http.org/en/latest/httplug/introduction.html) for making HTTP requests, therefore you will also need to install [a client or adapter](http://docs.php-http.org/en/latest/clients.html).

Usage
-----

```
setKey('')
->get('ID1 1QD');
```