PHPackages                             aotearoait/nzp-addresschecker - 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. aotearoait/nzp-addresschecker

ActiveLibrary

aotearoait/nzp-addresschecker
=============================

NZ Post Address Check Client

03PHP

Since Mar 1Pushed 5y ago1 watchersCompare

[ Source](https://github.com/aotearoait/nzp-addresschecker)[ Packagist](https://packagist.org/packages/aotearoait/nzp-addresschecker)[ RSS](/packages/aotearoait-nzp-addresschecker/feed)WikiDiscussions main Synced yesterday

READMEChangelogDependenciesVersions (1)Used By (0)

NZ Post Address Checker API client
==================================

[](#nz-post-address-checker-api-client)

This API client can help you to operate with NZ Post Address Checker API. You can use any PSR-16 Simple Cache with it to save your money on look ups number.

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

[](#installation)

`composer require dshumkov/nzpost-client`

Examples
--------

[](#examples)

The Address Checker API allows you to autocomplete and check New Zealand addresses and postcodes. It can be used within web forms or mobile apps. It’s backed by New Zealand Post’s National Postal Address Database (NPAD).

Firstly you have to get registered account And create new application there to get API credentials.

### Auth and get the client instance

[](#auth-and-get-the-client-instance)

```
use DShumkov\NzPostClient\NzPostClient;

$clientID = 'NZPOST_CLIENT_ID';
$secret = 'NZPOST_CLIENT_SECRET';

$Client = new NzPostClient($clientID, $secret);
```

### Auth and get the client instance with PSR-16 Simple Cache

[](#auth-and-get-the-client-instance-with-psr-16-simple-cache)

```
use Symfony\Component\Cache\Simple\FilesystemCache;
use DShumkov\NzPostClient\NzPostClient;

$cache = new FilesystemCache();
$ttl = 31536000; // One year cache TTL

$clientID = 'NZPOST_CLIENT_ID';
$secret = 'NZPOST_CLIENT_SECRET';

$Client = new NzPostClient($clientID, $secret, $cache);
$Client->setTTL($ttl);
```

### Get suggested addresses

[](#get-suggested-addresses)

```
$query = '1 Queen street';
$suggestedAddresses = $Client->suggest($query);
```

### Find an address

[](#find-an-address)

```
$addressLines = [
    '1 Queen street',
    'CBD',
    'Auckland'
 ];
 $addresses = $Client->find($addressLines);
```

### Get address details by DPID

[](#get-address-details-by-dpid)

Making calls to the address details services requires passing a DPID. This can be found by calling either the find or suggest resources which return matches including DPID's.

```
$dpid='3111226';
$addressDetails = $Client->details($dpid);
```

### The suggest partial addresses.

[](#the-suggest-partial-addresses)

The suggest partial addresses service takes a partial address query and turns a list of partial address matches.

```
$query = 'queen';
$suggestedAddresses = $Client->suggestPartial($query);
```

### The partial address details service.

[](#the-partial-address-details-service)

The partial address details service takes a partial's unique\_id and returns detailed information about the matching partial address.

```
$uniqId = 82868;
$response = $Client->partialDetails($uniqId);
```

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity30

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/cb51b0ee61ea30b25d365d02b68d32d697dac0238d1c0e0bf788f80b2d25cabe?d=identicon)[aotearoait](/maintainers/aotearoait)

---

Top Contributors

[![aotearoait](https://avatars.githubusercontent.com/u/33107115?v=4)](https://github.com/aotearoait "aotearoait (3 commits)")

### Embed Badge

![Health badge](/badges/aotearoait-nzp-addresschecker/health.svg)

```
[![Health](https://phpackages.com/badges/aotearoait-nzp-addresschecker/health.svg)](https://phpackages.com/packages/aotearoait-nzp-addresschecker)
```

PHPackages © 2026

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