Address Reverse Geocode API (NZ)

Build
Send
Response
Errors

This call takes the GPS coordinates (longitude and latitude) and returns the nearest addresses ordered by distance. This API works in tandem with the Address Metadata API which is used to load the metadata associated with the selected address.

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
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.
x *		Number	The longitude (in WGS84 format).
y *		Number	The latitude (in WGS84 format)
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.

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

Request URL

https://api.addressfinder.io/api/nz/address/reverse_geocode/

      
        /* 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
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

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