Points of Interest Metadata API (NZ)

Build
Send
Response
Errors

This API call takes a point of interest identifier, and returns detailed information about that point of interest.

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
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.
id *		String	Unique address id obtained from the Points of Interest 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/points_of_interest/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
`name`	String	The name of the point of interest	Whangarei Hospital
`pxid`	String	Unique point of interest identifier.	3-.1.1d.2.42.1T.2
`a`	String	Canonical address as supplied by Land Information New Zealand or NZ Post.	Unit 2, 1703A State Highway 1, Warkworth 0983
`postal`	String	Associated postal address when supplied by NZ Post. Field will be omitted if this address is not delivered to by NZ Post. FAQ: postal address vs 'a' address.	Unit 2, 1703A State Highway 1, RD 3, Warkworth 0983
`number`	String	The street number of the address. Also populated with the box number for PO Box type addresses.	1703
`alpha`	String	Holds the alpha component of a street number. In the address 1B High Street, B is the alpha.	B
`unit_identifier`	String	Identifies a specific sub dwelling. Can be alpha, number or a combination.	1
`unit_type`	String	Describes the category of a sub-dwelling.	flat
`floor`	String	The level number and level type in a multi-story building.	Level 19
`street`	String	Holds the full name of the street. Note: The street attribute also includes the Street Type.	State Highway 1
`street_type`	String	The type of street.	avenue
`building_name`	String	Holds the building or property name.	Miban Building
`suburb`	String	The suburb or locality of the address as assigned by Land Information New Zealand.	Warkworth
`post_suburb`	String	Name of the suburb when supplied by NZ Post.	Manukau
`city`	String	The city, town or locality name as assigned by Land Information New Zealand.	Warkworth
`mailtown`	String	Name of the town/city when supplied by NZ Post.	Warkworth
`ta`	String	The Territorial Authority in which this address exists. Territorial authorities are the second tier of local government in New Zealand.	Auckland
`region`	String	The Regional Authority in which this address exists. Note: Regional Authorities are the top tier of local government in New Zealand.	Auckland Region
`rd_number`	String	The rural delivery number assigned by NZ Post to a rural address.	4
`postcode`	String	Holds the four digit postcode.	0983
`meshblock`	String	The meshblock identifier for the requested census dataset (see `census` parameter). If not specified, the Census parameter will default to 2018.	146004
`address_pxid`	String	Address identifier for the address of this point of interest.	2-.F.11.8.G.4
`aims_address_id`	Integer	The unique identifier from Land Information New Zealand (LINZ).	103524
`dpid`	String	A unique reference number assigned to each delivery address by NZ Post.	2668726
`box_type`	String	The type of PO Box/CMB/Private Bag/Counter Delivery.	PO Box
`lobby_name`	String	The name of the NZ Post outlet or Agency outlet where the PO Box, Private Bag or Counter Delivery is located.	Fendalton
`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.