PHPackages                             addresso/addresso-php - 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. addresso/addresso-php

ActiveLibrary[API Development](/categories/api)

addresso/addresso-php
=====================

Official PHP client for the Addresso UK address lookup API

00PHP

Since Feb 17Pushed 2mo agoCompare

[ Source](https://github.com/addresso-co-uk/addresso-php)[ Packagist](https://packagist.org/packages/addresso/addresso-php)[ RSS](/packages/addresso-addresso-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Addresso PHP
============

[](#addresso-php)

Official PHP client for the [Addresso](https://addresso.co.uk) UK address lookup API.

- PHP 8.1+
- Zero dependencies (uses built-in cURL)
- Typed data classes with full IDE autocomplete

Installation
------------

[](#installation)

```
composer require addresso/addresso-php
```

Quick start
-----------

[](#quick-start)

```
use Addresso\Client;

$client = new Client('ak_your_api_key');

// Postcode lookup
$result = $client->lookupPostcode('SW1A 1AA');

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

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

echo "Found {$result->count} addresses\n";

// Account info
$account = $client->account();

echo "Credits remaining: {$account->creditsBalance}\n";
```

API
---

[](#api)

### `Client`

[](#client)

```
$client = new Client(string $apiKey, string $baseUrl = 'https://addresso.co.uk');
```

#### `lookupPostcode(string $postcode): PostcodeLookupResult`

[](#lookuppostcodestring-postcode-postcodelookupresult)

Look up all addresses at a UK postcode.

#### `searchAddresses(array $params): AddressSearchResult`

[](#searchaddressesarray-params-addresssearchresult)

Search for addresses by free text or structured fields. Supported params: `q`, `postcode`, `town`, `street`, `building_name`, `building_number`, `organisation`, `limit`.

#### `account(): AccountResult`

[](#account-accountresult)

Get your account status and remaining credits.

### Data classes

[](#data-classes)

All results return typed readonly objects:

- **`Address`** — `postcode`, `town`, `locality`, `subLocality`, `street`, `secondaryStreet`, `buildingNumber`, `buildingName`, `subBuilding`, `poBox`, `department`, `organisation`, `udprn`, `postcodeType`, `deliveryPointSuffix`, `latitude`, `longitude`
- **`PostcodeLookupResult`** — `postcode`, `addresses` (Address\[\]), `creditsRemaining`
- **`AddressSearchResult`** — `query`, `addresses` (Address\[\]), `count`, `creditsRemaining`
- **`AccountResult`** — `companyName`, `creditsBalance`, `earliestExpiry`

### Error handling

[](#error-handling)

All API errors throw `AddressoException` which extends `RuntimeException`:

```
use Addresso\AddressoException;

try {
    $result = $client->lookupPostcode('INVALID');
} catch (AddressoException $e) {
    echo $e->getMessage();       // "Invalid postcode"
    echo $e->getStatusCode();    // 400
}
```

License
-------

[](#license)

MIT

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance55

Moderate activity, may be stable

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity12

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/6a7e0e34db2e11ce468eadc6bb838b7738b2dbe754db0f69d89122c58d3741b5?d=identicon)[aaronduce](/maintainers/aaronduce)

---

Top Contributors

[![aaronduce](https://avatars.githubusercontent.com/u/20649108?v=4)](https://github.com/aaronduce "aaronduce (1 commits)")

### Embed Badge

![Health badge](/badges/addresso-addresso-php/health.svg)

```
[![Health](https://phpackages.com/badges/addresso-addresso-php/health.svg)](https://phpackages.com/packages/addresso-addresso-php)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)