addresso/addresso-laravel

Laravel integration for the Addresso UK address lookup API

dev-main 2026-02-17 15:10 UTC

Requires

• php: >=8.1
• addresso/addresso-php: ^1.0
• illuminate/support: ^10.0|^11.0|^12.0

MIT

• Addresso

• address
• laravel
• postcode
• lookup
• uk
• addresso

README

Laravel integration for the Addresso UK address lookup API.

Wraps addresso/addresso-php with a service provider, facade, and config publishing.

Installation

composer require addresso/addresso-laravel

The service provider and facade are auto-discovered.

Add your API key to .env:

ADDRESSO_API_KEY=ak_your_api_key

Optionally publish the config:

php artisan vendor:publish --tag=addresso-config

Usage

Facade

use Addresso\Laravel\Facades\Addresso;

// Postcode lookup
$result = Addresso::lookupPostcode('SW1A 1AA');

foreach ($result->addresses as $address) {
    echo "{$address->buildingNumber} {$address->street}, {$address->town}\n";
}

// Address search
$result = Addresso::searchAddresses(['q' => '10 Downing Street']);

// Account info
$account = Addresso::account();
echo "Credits: {$account->creditsBalance}";

Dependency injection

use Addresso\Client;

class AddressController extends Controller
{
    public function lookup(Client $addresso, string $postcode)
    {
        $result = $addresso->lookupPostcode($postcode);

        return response()->json($result);
    }
}

Helper via app container

$result = app('addresso')->lookupPostcode('SW1A 1AA');

Configuration

Environment Variable	Default	Description
ADDRESSO_API_KEY	''	Your Addresso API key
ADDRESSO_BASE_URL	https://addresso.co.uk	API base URL

License

MIT