Skip to main content

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

ParameterDescriptionTest 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

The format of the response.


Default value: json
Type: string required
pxid

Unique address identifier from the Location Autocomplete API.


Type: string required
domain

Used to identify your calling service for usage tracking in the Addressfinder Portal. Must be registered in the Portal.


Type: string

Responses

200 Location metadata for the selected pxid

NameDescriptionExample
pxidThe unique location identifier.

Type: string
1-.B.11.4.2H
aCanonical location string.

Type: string
Seaview Road, Glenfield, Auckland
xLongitude in WGS84.

Type: number
174.643199
yLatitude in WGS84.

Type: number
-36.426956
successWhether the request completed successfully.

Type: boolean
true
streetStreet name and type (from LINZ).

Type: string
Martin Street
suburbSuburb or locality name (from LINZ).

Type: string
Gore
cityCity, town, or locality (from LINZ).

Type: string
Gore
regionRegional Authority (from LINZ).

Type: string
Southland Region

400 Invalid input or missing parameters.

NameDescriptionExample
error

Type: string
Missing required parameter 'pxid'

See API Error Reference for details.