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	Description	Test Value
key	Your unique Addressfinder license key. Type: string required
secret	Your unique secret key from Portal Credentials. You can also pass your secret key into the Authorization header of the request. Only required for server-to-server calls. Type: string
format	Response format (json or xml). Type: string required	-- Select --jsonxml
id	Unique POI identifier from the autocomplete API. Type: string required
domain	Used to identify your service in the Addressfinder Portal. Must be registered in the Portal. Type: string

Responses

200 Metadata for the selected point of interest

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

400 Missing or invalid parameters

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

See API Error Reference for details.