POI Metadata API

The Points of Interest Metadata API is used to collect metadata for a POI selected from the Points of Interest Autocomplete API. Metadata includes location, street, region, LINZ and NZ Post data.

Endpoint

New Zealand

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

Parameters

Parameter	Default	Description	Test Value
key		Your unique Addressfinder license key. Required string
secret		Your unique secret key. You can also pass it in the Authorization header. Required only for server-to-server calls. Optional string
format		Response format (json or xml). Required string	-- Select --jsonxml
id		Unique POI identifier from the autocomplete API. Required string
domain		Used to identify your service in the Addressfinder Portal. Must be registered in the Portal. Optional string

Responses

200 Metadata for the selected point of interest

Name	Type	Description	Example
pxid	string	The unique point of interest identifier.	2457
name	string	Name of the point of interest.	Middle School West Auckland
x	string	Longitude (WGS84).	174.643199
y	string	Latitude (WGS84).	-36.426956
address_pxid	string	Unique identifier for the associated address.	2-.1.6.t.25oRi
number	string	Street number (or PO box number).	287-289
alpha	string	Alpha suffix from address (e.g. "B" in "1B").	-
postcode	string	Four-digit postcode.	0983
rd_number	string	NZ Post rural delivery number.	-
a	string	Canonical full address.	287-289 Lincoln Road, Henderson, Auckland 0610
postal	string	Postal address (if NZ Post delivers here).	-
mailtown	string	Mailtown from NZ Post (if available).	-
post_suburb	string	Postal suburb (if available).	-
ta	string	Territorial Authority (LINZ).	Auckland
aims_address_id	integer	LINZ AIMS Address ID.	1518959
sufi	integer	Same as aims_address_id, returned as integer.	1518959
street_type	string	Street type (e.g. Road, Avenue).	Road
building_name	string	Building name if available.	-
city	string	City, town or locality.	Warkworth
suburb	string	Suburb or locality.	Henderson
region	string	Regional Authority.	Auckland Region
street	string	Full street name and type.	Lincoln Road
postal_line_1	string	NZ Post Line 1.	287-289 Lincoln Road
postal_line_2	string	NZ Post Line 2.	Henderson
postal_line_3	string	NZ Post Line 3.	Auckland
postal_line_4	string	NZ Post Line 4.	-
postal_line_5	string	NZ Post Line 5.	-
meshblock	string	Meshblock identifier for census.	146004
dpid	string	Unique identifier from NZ Post.	2668726
success	boolean	Whether the request was successful.	true

400 Missing or invalid parameters

Name	Type	Description	Example
error	string		Missing required parameter 'id'

See API Error Reference for details.