Location Metadata API (NZ)

Build
Send
Response
Errors

This API call takes an location identifier, and returns detailed information about that location.

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 format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
pxid *		String	Unique location identifier obtained from the Location Autocomplete API.
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

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

Request URL

https://api.addressfinder.io/api/nz/location/metadata/

      
        /* Click the button above to see a real API response here */
        {
          "success": true
        }

Response Specification

The API response will contain all the addresses and associated IDs (pxid) in the format requested in the API request.

Field Name	Type	Description	Example
`a`	String	Canonical location as supplied by Land Information New Zealand.	Seaview Road, Glenfield, Auckland
`pxid`	String	Unique location identifier.	1-.6.M.1.M
`street`	String	Holds the full name of the street. Note: The street attribute also includes the Street Type.	Seaview Road
`suburb`	String	The suburb or locality of the address as assigned by Land Information New Zealand.	Glenfield
`city`	String	The city, town or locality name as assigned by Land Information New Zealand.	Auckland
`region`	String	The Regional Authority in which this location exists. Note: Regional Authorities are the top tier of local government in New Zealand.	Auckland Region
`x`	String	Longitude coordinate (in WGS84 format).	174.643199
`y`	String	Latitude coordinate (in WGS84 format).	-36.426956
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

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