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.

Build the request URL

Use the form below to build your request URL from the parameters. A URL string will be generated from these parameters and sent to the API in order to provide insight into how the API works and the responses it returns.

Field Name	Value	Type	Description
key *		String	Your unique licence key (find on Portal credentials)
secret *		String	Your unique secret key (find on Portal credentials)
q *		String	The partial address being searched.
format *		String	The required format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
delivered		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`
post_box		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.
rural		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.
strict		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.
region_code		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`
domain		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
max		Integer	The maximum number of results to return. A number between 1 and 100. The default is 10 results.
highlight		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

        
          /* 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.

Code	Error	Cause	Resolution
`1000`	Validation error	Returned when one of the supplied parameters is missing or incorrect. The response will contain a message attribute which explains the cause of the validation error. An example JSON response is shown below for a request which failed to include the `q` parameter. `{ completions: [ ], message: 'Q can not be blank', error_code: '1000' }`	Check that the supplied parameters contain valid values, and that the mandatory parameters have been included.
`1001`	Key not found	Returned when the key included in your API call cannot be found in our database. This will normally happen when you make a copy ’n paste error.	Compare the key included in your API call with the key listed in the AddressFinder Portal credentials. Also confirm there are no additional spaces or characters in your API call.
`1002`	Key not provided	Returned when you fail to send through your key with each request. The key is a mandatory parameter.	Check that you are using the correct parameter name `key`.
`1003`	Domain not registered with AddressFinder	Returned when you embed AddressFinder on a website that differs from the domain that you specified in the AddressFinder Portal.	The AddressFinder Portal records the domains that are allowed to use your account. Login to the AddressFinder Portal and add the domain of this website to your account.
`1004`	Secret not provided	Returned when you fail to send through your secret with an API call. Can also occur when using the widget and the HTTP `Referer` header is not included.	Include the secret listed in the AddressFinder Portal credentials in your API call. When using the widget, you must load the page from a web server (e.g. localhost) and not a `file://` scheme.
`1005`	Direct API calls are not permitted on your current plan.	Returned if you try to call the API and you are on either a Free or Agile plan. These plan types provide access to the JavaScript Widget and plugins only.	Upgrade to a Business plan. Visit the AddressFinder Portal to change plan.
`1006`	Invalid credentials	Returned when the supplied key and/or secret value are incorrect. This will normally happen when you make a copy ’n paste error.	Compare the key and secret included in your API call with the values listed on the AddressFinder Portal credentials page. Also confirm there are no additional spaces or characters in your API call.
`1008`	Secret should not be supplied	This is a safety check to ensure that the secret parameter has not been included when making requests from your web browser. You should never include the secret on any web page.	The secret should be used for server-to-server API calls only.
`1009`	The AddressFinder plugin has exceeded the number of allowed lookups, and is now suspended	Returned when your account (free plans only) has hit its 100% usage limit for the billing period.	Visit the AddressFinder Portal and switch to a Paid plan. Alternatively wait until the end of the month when suspended accounts are automatically reactivated.
`1010`	Account not authorised to use this API	Returned when you make an API call that you are not permitted to use	Contact AddressFinder support to request access to this API.
`1011`	The record you are trying to load does not exist	Returned when the supplied address identifier cannot be found. This can happen when a stale identifier is included in the API call.	Do not save address identifiers in your database, as they are transient and may change after each database update.
`1012`	Account not authorised to use this API	Returned when you make an API call that you are not permitted to use	Contact AddressFinder support to request access to this API.
`1013`	This API has been discontinued	This API has been discontinued	Contact AddressFinder support to discuss alternatives.
`1014`	Account Disabled	Your account has been disabled by AddressFinder support.	Contact AddressFinder support to discuss reactivating your account.
`1015`	Domain parameter must not be included in a web request	You have included a domain parameter in your browser based API call. The domain parameter is for direct API calls only.	Remove the domain parameter from your web request.
`1016`	This domain has been blocked	These credentials are not permitted to be used on this domain.	Contact AddressFinder support to discuss removing the block.
`1017`	This service is not enabled on your current plan	You have attempted to use an AddressFinder service that is not enabled on your current plan.	Visit the AddressFinder Portal to change plan.
`1018`	Your IP address has been blocked for these credentials	This service has been configured to only allow access from defined IP addresses.	Visit the AddressFinder Portal and add your IP address to the IP Allow List.
`1019`	HTTP Referer or Origin header record must be present when making a browser initiated request	You have attempted to use the AddressFinder widget from a browser that does not include the referrer or orgin headers along with each request.	Confirm that this request was sent from a valid web server (not the local filesystem), and that you do not have browser plugins interfering with the request.
`1020`	Your AddressFinder trial has ended	Returned when the trial term has ended.	Log into the AddressFinder Portal and upgrade your account to a suitable plan.
`1021`	Your AddressFinder trial has exceeded its allowed lookups	Returned when you have exceeded the number of lookups permitted on the trial plan.	Log into the AddressFinder Portal and upgrade your account to a suitable plan.
`1022`	Postal addresses are not enabled on your current plan	You have attempted to query postal addresses, this service is not included in your current plan.	You can use our service without specifying postal addresses. For Australia, use the param `gnaf:1` (and remove `au_paf:1`). For New Zealand, remove `delivered:1` and `post_box:1`. If you would like to continue using postal addresses, log into the AddressFinder Portal and upgrade your account to a suitable plan.