Location Metadata API

The Location Metadata API is used to collect metadata associated with a location selected from the New Zealand Location Autocomplete API. The response includes geographic coordinates, canonical address formatting, and location metadata from LINZ.

Endpoint

New Zealand

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

Parameters

Parameter	Default	Description
`key`		Your unique Addressfinder license key. Required string
`secret`		Your unique secret key. You can also pass it into the `Authorization` header. Required only for server-to-server calls. Optional string
`format`	`json`	The format of the response. Required string
`pxid`		Unique address identifier from the Location Autocomplete API. Required string
`domain`		Used to identify your calling service for usage tracking in the Addressfinder Portal. Must be registered in the Portal. Optional string

Responses

200 Location metadata for the selected pxid

Name	Type	Description	Example
`pxid`	string	The unique location identifier.	1-.B.11.4.2H
`a`	string	Canonical location string.	Seaview Road, Glenfield, Auckland
`x`	number	Longitude in WGS84.	174.643199
`y`	number	Latitude in WGS84.	-36.426956
`success`	boolean	Whether the request completed successfully.	true
`street`	string	Street name and type (from LINZ).	Martin Street
`suburb`	string	Suburb or locality name (from LINZ).	Gore
`city`	string	City, town, or locality (from LINZ).	Gore
`region`	string	Regional Authority (from LINZ).	Southland Region

400 Invalid input or missing parameters.

Name	Type	Description	Example
`error`	string		Missing required parameter 'pxid'

See API Error Reference for details.