matthewbdaly/postcode-client

A postcode lookup client.

0.0.3 2017-11-28 12:14 UTC

Requires

• php-http/client-implementation: ^1.0
• php-http/discovery: ^1.0
• php-http/httplug: ^1.0
• php-http/message-factory: ^1.0
• psr/http-message: ^1.0

Requires (Dev)

• guzzlehttp/psr7: ^1.0
• php-http/message: ^1.0
• php-http/mock-client: ^1.0
• phpspec/phpspec: ^3.2
• psy/psysh: ^0.8.0
• squizlabs/php_codesniffer: ^2.7

MIT

• Matthew Daly

• postcode

README

Postcode lookup client. Uses Ideal Postcodes 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 for making HTTP requests, therefore you will also need to install a client or adapter.

Usage

<?php

require 'vendor/autoload.php';

use Matthewbdaly\Postcode\Client;

$client = new Client();
$response = $client->setKey('<MY_API_KEY>')
    ->get('ID1 1QD');