New Zealand addresses

Customers across the Tasman? Switch on the New Zealand addresses add-on and the same subscription finds New Zealand addresses too, at their own two endpoints: NZ Autocomplete and NZ Get.

• $11 a month, added to your paid subscription's bill (eleven months' worth on a yearly plan). Switching it on charges your card straight away for the rest of the billing period; switching it off stops it from the next bill, with no refund. A Free subscription upgrades first. Each NZ Get counts as one look-up from your subscription's existing allowance; NZ Autocomplete is free and rate limited, like Autocomplete.
• The same API key, domain tokens and rate limits as your Australian look-ups.
• Addresses are LINZ's NZ Addresses, refreshed weekly. Postcodes are not yet NZ Post's own: each address says where its postcode came from (postcode_source, postcode_official).
• Without the add-on, both endpoints answer 403.

Switching it on

On the Add-ons tab of your console, or through the API with your subscription's admin key. Either way it reaches the NZ endpoints within a minute.

PUT https://api.getaddress.io/subscription/add-ons/nz-addresses?api-key={your-admin-key} 

Body

{
    "enabled": true
}

Response

{
    "name": "main",
    "add_on": "nz-addresses",
    "enabled": true,
    "add_ons": [ "nz-addresses" ]
}

Send {"enabled": false} to switch it off. The address API key is refused here (403); only the admin key can change add-ons. An add-on name that does not exist is a 404. A 400 means nothing changed: the subscription is Free, or the card was declined.

Attribution

New Zealand address data is LINZ's, under CC BY 4.0. If you display or redistribute it, credit LINZ as the Data Attribution page shows.