AddressFinder

The best way to find exact addresses in New Zealand

  • Skip to Main Navigation
  • Skip to Footer Sitemap
  • Skip to Top
Menu

Get Started Free

  • Pricing
  • Features & plugins
  • About us
  • Case studies
  • FAQ
  • Contact
  • Blog
  • JavaScript widget docs
  • API developer docs
  • Log in
  • Pricing
  • Features
  • More
    • Company & product
      • About Us
      • Case Studies
      • FAQ
      • Partners
      • Blog
      Contact Us
    • Integrations
      • Magento
      • WooCommerce
      • BigCommerce
      • Salesforce
      • Shopify Plus
      See all integrations
    • JavaScript widget docs
      • Integration Guide
      • Widget Code Generator
      • Widget Reference
      • Code Examples
      See all JavaScript docs
    • API developer docs
      • Address Autocomplete
      • Address Metadata
      • Address Verification
      • API Errors
      See all API docs
  • Log in
  • Get Started Free

Address Autocomplete API (NZ)

  • Build
  • Send
  • Response
  • Errors

This API is used to power the autocomplete capability of the AddressFinder widget. It can also be used to power your own custom autocomplete functionality, such as in a mobile or desktop app. If you want to call this API from a web browser, there are some special guidelines that you will need to follow.

This page contains the technical API information for our Address Autocomplete. Please visit our address autocomplete page if you are looking to learn more about the service

Build the request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Field Name Value Type Description
String Your unique licence key (find on Portal credentials)
String Your unique secret key (find on Portal credentials). Alternatively, you can pass your secret key into the Authorization header of the request as such: Authorization: your-secret
String The partial address being searched.
String The required format of the response.
  • Options

    json json for a response in json format.

    xml xml for a response in xml format.

String This filter determines if the results are either delivered or not delivered by NZ Post.
  • Options

    Non-delivered addresses only 0 A rarely used option that excludes addresses that NZ Post deliver to.

    Delivered addresses only 1

String This filter includes/excludes PO Box style addresses.
  • Options

    Exclude PO Box addresses 0

    PO Box only 1 Returns only PO Box, Private Bag, Community Mailbox and Counter Delivery address types.

String This filter includes/excludes rural/urban addresses.
  • Options

    Urban addresses only 0 Excludes addresses likely to be considered rural by a courier company.

    Rural addresses only 1 A rarely used option that returns rural addresses only.

String Determines how closely matched the results should be to the q parameter.
  • Options

    Normal search 0 Allows some address elements to be omitted but does not allow spelling errors.

    Strict search 1 Requires all address elements entered in q to be ordered and spelt correctly.

    Fuzzy search 2 Allows spelling errors and inaccurate address elements.

String Only return addresses within the boundary of the selected region (Regional Authority).
  • Options

    Auckland 1

    Bay of Plenty 2

    Canterbury 3

    Gisborne 4

    Hawke's Bay 5

    Manawatu-Wanganui 6

    Marlborough 7

    Nelson 8

    Northland 9

    Otago A

    Southland B

    Taranaki C

    Tasman D

    Waikato E

    Wellington F

    West Coast G

    Chatham Islands H

String Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. FAQ: learn more about the domain parameter
Integer The maximum number of results to return. A number between 1 and 100. The default is 10 results.
Integer Returns an additional attribute in the response called highlighted_a. This attribute wraps the matching terms in the address with <span class='af_hl'></span> in order to highlight those terms.
  • Options

    Highlighted 1

* Parameters marked with an asterisk are mandatory for this API call.

Request URL

https://api.addressfinder.io/api/nz/address/autocomplete/
      
        /* Click the button above to see a real API response here */
        {
          "success": true
        }
      
    

Response Specification

The API response will contain a hash with an element named completions, which is an array of hashes containing the following fields.

Field Name Type Description Example
a
String Canonical address as supplied by Land Information New Zealand or NZ Post. 184 Williams Street, Kaiapoi 7630
pxid
String The unique address identifier. 2-.3.1q.2.4G.4c
v
Integer This is a deprecated field and is only retained for backwards compatibility reasons. You should ignore this field. 0
highlighted_a
String When highlighting is enabled, contains the full address string with highlighted matching terms. <span class='af_hl'>184</span> <span class='af_hl'>Will</span>iams Street, Kaiapoi 7630
success
Boolean Indicates if the request was successful or not. true

Errors

Below are the possible errors that can be returned by the API.

  • Validation error (1000)
  • Key not found (1001)
  • Key not provided (1002)
  • Domain not registered with AddressFinder (1003)
  • Secret not provided (1004)
  • Direct API calls are not permitted on your current plan. (1005)
  • Invalid credentials (1006)
  • Secret should not be supplied (1008)
  • The AddressFinder plugin has exceeded the number of allowed lookups, and is now suspended (1009)
  • Account not authorised to use this API (1010)
  • The record you are trying to load does not exist (1011)
  • Account not authorised to use this API (1012)
  • This API has been discontinued (1013)
  • Domain parameter must not be included in a web request (1015)
  • This domain has been blocked (1016)
  • This service is not enabled on your current plan (1017)
  • Your IP address has been blocked for these credentials (1018)
  • HTTP Referer or Origin header record must be present when making a browser initiated request (1019)
  • Your AddressFinder trial has ended (1020)
  • Your AddressFinder trial has exceeded its allowed lookups (1021)
  • Postal addresses are not enabled on your current plan (1022)
  • JavaScript Widget
    • Integration guide
    • Widget code generator
    • Code examples
    • Best practices
    • Fixing browser quirks
    • Advanced usage
    • Can't find your address?
    • JavaScript widget reference
  • API Specs (NZ)
    • Address Autocomplete
    • Address Metadata
    • Address Verification
    • Address Reverse Geocode
    • Address Bounding Box
    • Location Autocomplete
    • Location Metadata
    • Points of Interest Autocomplete
    • Points of Interest Metadata
    • API Errors
  • API Specs (AU)
  • Integrations
    • Magento
    • WooCommerce
    • BigCommerce
    • Salesforce
    • Shopify Plus
    • Spiffy Stores
    • Ruby
    • iOS
    • Drupal
    • Microsoft Dynamics 365
    • Vue
    • Gravity Forms
    • React

Sitemap

Home

  • About
  • Contact
  • Blog
  • FAQ
  • Pricing
  • Case Studies
  • Status Page
  • Privacy Policy
  • Terms & Conditions

Features

  • Address Autocomplete
  • Address Verification
  • Address Metadata
  • Geocode Addresses
  • Reverse Address Lookup
  • Points of Interest
  • Street, Suburb & City Search
  • Bounding Box Search
  • Postcode Finder

Integrations

  • WooCommerce
  • BigCommerce
  • Shopify Plus
  • Magento
  • Salesforce
  • Spiffy Stores
  • iOS
  • Ruby
  • Drupal
  • Microsoft Dynamics 365
  • Vue
  • Gravity Forms
  • React

API Documentation

  • Address Autocomplete
  • Address Metadata
  • Address Verification
  • API Errors
  • Another 6 APIs
  • AU APIs specs

Widget Documentation

  • Integration Guide
  • Code Generator
  • Code Examples
  • Javascript Reference

AddressFinder is also available in Australia

AddressFinder provides speedy, accurate and dependable address autocompletion at a fair price. Easily integrate our address finder software with your site to start enjoying our address verification, address autocomplete and other address services today.