petelawrence / getaddress
A PHP library for the getaddress.io postcode lookup service
Installs: 108 413
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 5
Open Issues: 2
Requires
- guzzlehttp/guzzle: ~6.0
Requires (Dev)
- instaclick/php-code-sniffer: ~1
- pdepend/pdepend: 2.0.*
- phploc/phploc: 2.0.*@dev
- phpmd/phpmd: dev-master
- phpunit/php-code-coverage: 2.0.*@dev
- phpunit/phpunit: ~4
- phpunit/phpunit-mock-objects: 2.0.*@dev
- sebastian/environment: 1.0.*@dev
- sebastian/phpcpd: 2.0.*
- sebastian/version: 1.0.*
- theseer/phpdox: ~0
This package is not auto-updated.
Last update: 2025-03-29 20:08:52 UTC
README
A PHP library for the getaddress.io postcode lookup service
Pre-requisites
You will require a getaddress.io API key. For low use applications (fewer than 20 lookups/day) this is free.
Usage
$client = new \petelawrence\getaddress\GetAddressClient('YOUR-GETADDRESS.IO-KEY');
$result = $client->lookup('NR10 4JJ');
$address0 = $result->getAddresses()[0];
echo $address0->getTown();
Tests
GETADDRESSKEY=YOUR-GETADDRESS.IO-KEY vendor/bin/phpunit tests/