Download the PHP package laralabs/get-address-io without Composer
On this page you can find all versions of the php package laralabs/get-address-io. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download laralabs/get-address-io
More information about laralabs/get-address-io
Files in laralabs/get-address-io
Package get-address-io
Short Description Laravel package for getAddress.io
License MIT
Informations about the package get-address-io
Laravel getAddress.io Package
This package allows you to easily interact with the getAddress.io API and cache full postcode results to reduce quota usage.
:rocket: Quick Start
Installation
Require the package in the composer.json
of your project.
Publish the configuration file.
Edit the configuration file and set your desired settings, the cache is disabled by default and you will need to set the following env variables:
If you have enabled the cache, make sure you run the migration:
Usage
A helper function and facade is available, choose your preferred method.
The facade is located at Laralabs\GetAddress\Facades\GetAddress
The endpoints currently supported are (support for other endpoints coming soon):
- find
- autocomplete
- get
Perform a lookup using the find
endpoint:
The $property
argument is optional, just searching for a postcode will return all results for that postcode and also cache the data if the cache has been enabled.
Perform a looking using the autocomplete
endpoint:
The second argument supports an array of parameters to send with the POST request, the example above shows setting the returned results to the maximum allowed of 20.
Perform a lookup using the get
endpoint:
This is used with the autocomplete
endpoint to return the full address information, the $addressId
argument must be the ID returned from the autocomplete response.
:speech_balloon: Support
Please raise an issue on GitHub if there is a problem.
:key: License
This is open-sourced software licensed under the MIT License.
All versions of get-address-io with dependencies
guzzlehttp/guzzle Version ^7.2
laravel/framework Version ^10.0|^11.0|^12.0