PHPackages ashleighsims/get-address-wrapper - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. ashleighsims/get-address-wrapper ActiveLibrary[API Development](/categories/api) ashleighsims/get-address-wrapper ================================ Get Address IO wrapper covering all endpoints available from the API. 1.1.1(5y ago)4561MITPHPPHP ^7.1.8 || ^8.0CI failing Since Feb 19Pushed 5y ago1 watchersCompare [ Source](https://github.com/ashleighsims/get-address-wrapper)[ Packagist](https://packagist.org/packages/ashleighsims/get-address-wrapper)[ Docs](https://github.com/ashleighsims/get-address-wrapper)[ RSS](/packages/ashleighsims-get-address-wrapper/feed)WikiDiscussions master Synced today READMEChangelog (3)Dependencies (5)Versions (4)Used By (0) Get Address IO Wrapper ====================== [](#get-address-io-wrapper) A simple wrapper for the GetAddress IO service. Allowing the retrieval of address information from the provided post code. as well as other services. Installation ------------ [](#installation) Before you can start using GetAddress IO you will need to register for an API key. There is a free API key that you can use for 30 days before moving onto a paid plan. You can get an API key and find out more information here: Via Composer ``` $ composer require ashleighsims/get-address-wrapper ``` ### Laravel [](#laravel) If you're using this package in Laravel auto discovery has been enabled so you should be able to hit the ground running (when using Laravel 5.5 and beyond) if you aren't using Laravel 5.5 and above you will need to manually register some bits... Register the provider in the app.php file: ``` AshleighSims\GetAddressWrapper\Laravel\GetAddressWrapperServiceProvider::class ``` Optionally register the Facade: ``` 'GetAddress' => AshleighSims\GetAddressWrapper\Laravel\GetAddressWrapperServiceProvider::class ``` Please ensure you've added the below environment variables to your `.env` file before starting. #### Environment Variables [](#environment-variables) Add the following environment variables to your .env file. ``` GET_ADDRESS_BASE_URL="https://api.getaddress.io" GET_ADDRESS_API_KEY="" GET_ADDRESS_ADMINISTRATION_API_KEY="" GOOGLE_PLACES_API_KEY="" ``` Usage ----- [](#usage) ### Laravel [](#laravel-1) #### Dependency Injection Via Controller [](#dependency-injection-via-controller) ``` use AshleighSims\GetAddressWrapper\GetAddressWrapper; ... private $getAddress; public function __construct(GetAddressWrapper $getAddress) { $this->getAddress = $getAddress; } public function getPostcodeAddressList() { $response = $this->getAddress->findByPostcode()->find('SW1A 1AA'); } ... ``` #### Facade [](#facade) ``` use AshleighSims\GetAddressWrapper\Laravel\Facades\GetAddressWrapper; ... public function getAddress() { $response = GetAddressWrapper::findByPostcode()->find('SW1A 1AA'); } ... ``` ### General Usage [](#general-usage) #### Find [](#find) ##### List of addresses from postcode [](#list-of-addresses-from-postcode) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->findByPostcode()->find('SW1A 1AA'); ``` Return: Array of AshleighSims\\GetAddressWrapper\\Response\\Address Objects ##### Address from postcode and building number [](#address-from-postcode-and-building-number) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->findByPostcode()->findWithNumber('SW1A 1AA', 'Buckingham Palace'); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\Address #### Distance [](#distance) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->distance()->between('SW1A 1AA', 'SL4 1QF'); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\Distance #### Autocomplete - Postcodes [](#autocomplete---postcodes) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->autoCompletePostcode()->complete('SW1A'); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\GooglePlacesPostcodePrediction #### Autocomplete - Places [](#autocomplete---places) ##### Places [](#places) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->>autoCompletePlaces()->complete('Buckingham'); ``` Return: Array of AshleighSims\\GetAddressWrapper\\Response\\GooglePlacesPrediction Objects ##### Place Details [](#place-details) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->autoCompletePlaces()->findByGooglePlacesId('ChIJtV5bzSAFdkgRpwLZFPWrJgo'); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\GooglePlace #### Usage [](#usage-1) ##### Current day [](#current-day) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->usage()->get(); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\Usage ##### Given date [](#given-date) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->usage()->getByDate('18/02/2020', 'd/m/Y'); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\Usage ##### Date range [](#date-range) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->usage()->getBetween('18/02/2020', '19/02/2020', 'd/m/Y'); ``` Return: Array of AshleighSims\\GetAddressWrapper\\Response\\DailyUsage Objects #### Private Address List [](#private-address-list) ##### Add address [](#add-address) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->privateAddress()->add('SW1A 1AA', [ 'line1' => 'Ashleigh\'s Palace', 'line2' => '', 'line3' => '', 'line4' => '', 'locality' => '', 'townOrCity' => 'London', 'county' => '', ]); ``` Return: JSON decoded associative array ##### Delete address [](#delete-address) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->privateAddress()->delete('SW1A 1AA', '1'); ``` Return: JSON decoded associative array ##### Get address [](#get-address) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->privateAddress()->get('SW1A 1AA', '1'); ``` Return: Object AshleighSims\\GetAddressWrapper\\Response\\PrivateAddress ##### List addresses [](#list-addresses) ``` $getAddress = new GetAddressWrapper('api-key', 'admin-api-key', 'google-places-api-key', 'https://api.getAddress.io'); $response = $getAddress->privateAddress()->list('SW1A 1AA'); ``` Return: Array of AshleighSims\\GetAddressWrapper\\Response\\PrivateAddress Objects Change log ---------- [](#change-log) Please see the [changelog](CHANGELOG.md) for more information on what has changed recently. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. License ------- [](#license) license. Please see the [license file](LICENSE.md) for more information. ### Health Score 30 — LowBetter than 64% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community7 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~146 days Total 3 Last Release 1980d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1674351?v=4)[Ashleigh Sims](/maintainers/ashleighsims)[@ashleighsims](https://github.com/ashleighsims) --- Top Contributors [![ashleighsims](https://avatars.githubusercontent.com/u/1674351?v=4)](https://github.com/ashleighsims "ashleighsims (5 commits)") --- Tags laravellaravel-6-packagelaravel-packagesphp7postcode-lookuplaravelGet Address IOPostcode Address Lookup ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/ashleighsims-get-address-wrapper/health.svg) ``` [![Health](https://phpackages.com/badges/ashleighsims-get-address-wrapper/health.svg)](https://phpackages.com/packages/ashleighsims-get-address-wrapper) ``` ### Alternatives [openai-php/laravel OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API 3.7k7.6M74](/packages/openai-php-laravel)[statamic/cms The Statamic CMS Core Package 4.8k3.2M720](/packages/statamic-cms)[irazasyed/telegram-bot-sdk The Unofficial Telegram Bot API PHP SDK 3.3k4.5M84](/packages/irazasyed-telegram-bot-sdk)[flat3/lodata OData v4.01 Producer for Laravel 96320.9k](/packages/flat3-lodata)[laravel-freelancer-nl/laravel-index-now Alert search engines of content changes. 5212.1k](/packages/laravel-freelancer-nl-laravel-index-now)[scriptdevelop/whatsapp-manager Paquete para manejo de WhatsApp Business API en Laravel 762.6k](/packages/scriptdevelop-whatsapp-manager) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)