Download the PHP package ashleighsims/get-address-wrapper without Composer
On this page you can find all versions of the php package ashleighsims/get-address-wrapper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ashleighsims/get-address-wrapper
More information about ashleighsims/get-address-wrapper
Files in ashleighsims/get-address-wrapper
Package get-address-wrapper
Short Description Get Address IO wrapper covering all endpoints available from the API.
License MIT
Homepage https://github.com/ashleighsims/get-address-wrapper
Informations about the package get-address-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
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: https://getaddress.io/
Via Composer
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:
Optionally register the Facade:
Please ensure you've added the below environment variables to your .env
file before starting.
Environment Variables
Add the following environment variables to your .env file.
Usage
Laravel
Dependency Injection Via Controller
Facade
General Usage
Find
List of addresses from postcode
Return: Array of AshleighSims\GetAddressWrapper\Response\Address Objects
Address from postcode and building number
Return: Object AshleighSims\GetAddressWrapper\Response\Address
Distance
Return: Object AshleighSims\GetAddressWrapper\Response\Distance
Autocomplete - Postcodes
Return: Object AshleighSims\GetAddressWrapper\Response\GooglePlacesPostcodePrediction
Autocomplete - Places
Places
Return: Array of AshleighSims\GetAddressWrapper\Response\GooglePlacesPrediction Objects
Place Details
Return: Object AshleighSims\GetAddressWrapper\Response\GooglePlace
Usage
Current day
Return: Object AshleighSims\GetAddressWrapper\Response\Usage
Given date
Return: Object AshleighSims\GetAddressWrapper\Response\Usage
Date range
Return: Array of AshleighSims\GetAddressWrapper\Response\DailyUsage Objects
Private Address List
Add address
Return: JSON decoded associative array
Delete address
Return: JSON decoded associative array
Get address
Return: Object AshleighSims\GetAddressWrapper\Response\PrivateAddress
List addresses
Return: Array of AshleighSims\GetAddressWrapper\Response\PrivateAddress Objects
Change log
Please see the changelog for more information on what has changed recently.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
License
license. Please see the license file for more information.