Addy's RESTful Postcode Finder API, also know as the Postcode Search API or Postcode Lookup API, will find all of the postal codes in New Zealand and provide the capability to filter post codes by suburb or city. The post code finder takes postcode, city or suburb fragments and validates them it against the New Zealand Postal Address File (PAF) for accurate search results.

What is NZ postcode?

New Zealand uses a unique 4-digit postcode, defined by NZ Post to help identify the region, city and suburb used for mail deliveries.

Why are postcodes important?

Using a service such as a NZ post code finder will validate that an accurate postcode was entered to reduce delays caused by returned mail or multiple re-deliveries.

What is fuzzy post code searching?

Fuzzy postcode searching is used for returning accurate post codes even when city or suburb filters are entered with spelling mistakes and typos.

The example below will make a JSON request to search for post codes in "Devonport" by adding the API key in the request header:

1'curl -X GET --header 'Accept: application/json' --header 'addy-api-key: demo-api-key' 'https://api-nz.addysolutions.com/postcode?s=Devonport'

Lookup the "Devonport" postcodes using the API key as a query string parameter:

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

Postcode Model Description

Call the address Discovery API to retrieve all of the addresses by postcode, city or suburb.

Response Example: "Devonport" suburb search criteria
https://api-nz.addysolutions.com/postcode?key=demo-api-key&s=Devonport

{
    "postcodes": [
      {
        "postcode": "0624",
        "city": "Auckland",
        "suburb": "Devonport"
      },
      {
        "postcode": "0622",
        "city": "Auckland",
        "suburb": "Devonport"
      }
    ]
  }