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 | 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 Type: string | |
format | The format of the response. Default value: Type: json 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
Name | Description | Example |
---|---|---|
pxid | The unique location identifier. Type: string | 1-.B.11.4.2H |
a | Canonical location string. Type: string | Seaview Road, Glenfield, Auckland |
x | Longitude in WGS84. Type: number | 174.643199 |
y | Latitude in WGS84. Type: number | -36.426956 |
success | Whether the request completed successfully. Type: boolean | true |
street | Street name and type (from LINZ). Type: string | Martin Street |
suburb | Suburb or locality name (from LINZ). Type: string | Gore |
city | City, town, or locality (from LINZ). Type: string | Gore |
region | Regional Authority (from LINZ). Type: string | Southland Region |
400 Invalid input or missing parameters.
Name | Description | Example |
---|---|---|
error | Type: string | Missing required parameter 'pxid' |
See API Error Reference for details.