Location Autocomplete API (NZ)

Build
Send
Response
Errors

This API lets you search for streets, suburbs, cities and/or regions (we call these locations).

The filters below are applied additively, so if you need to return multiple location types, you should exclude those location types that are not required.

For example, to search for suburbs and cities apply filters of streets=0 and regions=0

Build the GET 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
key *		String	Your unique licence key (find on Portal credentials)
secret *		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`. FAQ: Learn more about authenticating direct API calls in request headers
q *		String	The query string to be matched with the location.
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.
street		String	This filter restricts results to streets
	Options not street `0` Return everything other than streets street `1` Return only streets
suburb		String	This filter restricts results to suburbs.
	Options not suburb `0` Return everything other than suburbs suburb `1` Return only suburbs
city		String	This filter restricts results to cities.
	Options not city `0` Return everything other than cities. city `1` Return only cities
region		String	This filter restricts results to regions.
	Options not region `0` Return everything other than regions region `1` Return only regions
region_code		String	Only return locations within the boundary of the selected region (Regional Authority).
	Options Auckland `1` Bay of Plenty `2` Canterbury `3` Gisborne `4` Hawke's Bay `5` Manawatū-Whanganui `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`
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.
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

https://api.addressfinder.io/api/nz/location/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 location as supplied by Land Information New Zealand.	Willcox Grove, Naenae, Lower Hutt
`pxid`	String	The unique location identifier.	1-.F.b.M.1C
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

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