The Address Discovery API is great at finding and retrieving bulk New Zealand addresses based on optional filter criteria. For example, retrieve all addresses by road, suburb, city, postcode, territory or region.

Use cases for this API:

Refreshing Addresses: Retrieve addresses that were modified after a given date to keep your database up to date and improve your address statement of accuracy.

Combining Census Data: Find all of the properties in meshblock (a small geographic location as defined by Statistics NZ), to get insight into census data such as average income, age, population, religion, gender diversity and more.

The example below will make a JSON request to retrieve all of the addresses with a postcode of 1010:

1curl -X GET --header 'Accept: application/json' 'https://api-nz.addysolutions.com/discovery?key=demo-api-key&postcode=1010'

Address Response Property Description

The Address Discovery API works in conjunction with the Address Details API.

Call the Address Details API endpoint (e.g. /address/2417575) to retrieve detailed address metadata for a search result.

Response Example for retrieving the first 2 addresses from "Lomond Street"

{
    "addresses": [
      {
        "id": 1199201,
        "displayname": "1 Lomond Street, Caversham, Dunedin 9012",
        "_link": "/address/1199201"
      },
      {
        "id": 1199202,
        "displayname": "3 Lomond Street, Caversham, Dunedin 9012",
        "_link": "/address/1199202"
      }
    ],
    "_links": {
      "next": "/discovery?limit=2&road=Lomond+Street&offset=2"
    }
  }