Loading...
Sign in to see the examples with your own API key.

NZ Autocomplete

Suggestions for a partial New Zealand address, the same way Autocomplete suggests Australian ones. Part of the New Zealand addresses add-on: switch it on for your subscription first, or the request is refused with 403.

Step 1.

Request

GET https://api.getaddress.io/nz/autocomplete/{term}?api-key={your-api-key}

Example: 12 queen st auckland central

Response

{
    "suggestions":
    [
        {
            "address": "12 Queen Street, Auckland Central, Auckland 1010",
            "url": "/nz/get/1131927",
            "id": "1131927"
        }
    ]
}
Step 2.

The selected 'Id' is passed to NZ Get to return the full address.

Parameters

Parameter Description
term What has been typed so far. A number at the front ("12 queen st", "2/12 east st", "12a queen st") narrows the search to that number, unit and suffix.
top How many suggestions to return, 1 to 6. Default 6.
template The suggestion text, built from {suburb_locality} (also {locality}), {town_city} and {postcode}. Default: the full address and postcode.

Usage

  • NZ Autocomplete requests do not count as look-ups.
  • A domain token works in place of your API key.

Rate Limiting

NZ Autocomplete shares your subscription's rate limit with every other request. Exceeding it returns a HTTP 429 response.
The Retry-After HTTP header contains the number of seconds until a successful retry can be made.

Top