The Address Metadata API is used to collect the metadata associated with an address selected from the Address Autocomplete API
Response Specification
The API response will contain all the addresses and associated IDs (pxid
) in the format requested in the API request.
Field Name | Type | Description | Example |
---|---|---|---|
a
|
String | Canonical address as supplied by Land Information New Zealand or NZ Post. | Unit 2, 1703A State Highway 1, Warkworth 0983 |
postal
|
String | Associated postal address when supplied by NZ Post. Field will be omitted if this address is not delivered to by NZ Post. FAQ: postal address vs 'a' address. | Unit 2, 1703A State Highway 1, RD 3, Warkworth 0983 |
building_name
|
String | Holds the building or property name. | Miban Building |
unit_type
|
String | Describes the category of a sub-dwelling. | Flat |
unit_identifier
|
String | Identifies a specific sub dwelling. Can be alpha, number or a combination. | 1 |
floor
|
String | The level number and level type in a multi-story building. | Level 19 |
number
|
String | The street number of the address. Also populated with the box number for PO Box type addresses. | 1703 |
alpha
|
String | Holds the alpha component of a street number. In the address 1B High Street, B is the alpha. | B |
street
|
String | Holds the full name of the street as supplied by Land Information New Zealand or NZ Post. Note: The street attribute also includes the Street Type. | Pūrākaunui Road |
street_name
|
String | Holds the name of the street as supplied by Land Information New Zealand or NZ Post. | Pūrākaunui |
post_street
|
String | Holds the street name and type from NZ Post, it will be omitted if the address is not delivered to by NZ Post. | Purakaunui Road |
post_street_name
|
String | Holds the street name from NZ Post, it will be omitted if the address is not delivered to by NZ Post. | Purakaunui |
street_type
|
String | The type of street. | Avenue |
street_suffix
|
String | The suffix of the street. Typically contains a compass direction. | North |
suburb
|
String | The suburb or locality of the address as assigned by Land Information New Zealand. | Warkworth |
city
|
String | The city, town or locality name as assigned by Land Information New Zealand. | Warkworth |
box_type
|
String | The type of PO Box/CMB/Private Bag/Counter Delivery. | PO Box |
lobby_name
|
String | The name of the NZ Post outlet or Agency outlet where the PO Box, Private Bag or Counter Delivery is located. | Fendalton |
rd_number
|
String | The rural delivery number assigned by NZ Post to a rural address. | 4 |
post_suburb
|
String | Name of the suburb when supplied by NZ Post. | Manukau |
mailtown
|
String | Name of the town/city when supplied by NZ Post. | Warkworth |
postcode
|
String | Holds the four digit postcode. | 0983 |
dpid
|
String | A unique reference number assigned to each delivery address by NZ Post. | 2668726 |
primary_parcel_id
|
String | The unique identifier of the portion of land associated with the selected address. | 3866475 |
aims_address_id
|
String | The unique identifier from Land Information New Zealand (LINZ). | 1518959 |
x
|
String | Longitude coordinate (in WGS84 format). | 174.643199 |
y
|
String | Latitude coordinate (in WGS84 format). | -36.426956 |
meshblock
|
String | The meshblock identifier for the requested census dataset (see census parameter). If not specified, the Census parameter will default to 2018. |
146004 |
sa1_id
|
String | Statistical area 1 (2018 census only) | 7000001 |
sa2_id
|
String | Statistical area 2 ID (2018 census only) | 100200 |
sa2
|
String | Statistical area 2 name (2018 census only) | Rangaunu Harbour |
rural
|
Boolean | An indicator to help determine if this address is located in a rural setting. Note: Different courier companies have different rural/urban boundaries so this determination should be confirmed by your delivery agent. | true |
ur
|
String | Urban rural name (2018 census only) | Kaimaumau |
ur_id
|
String | Urban rural ID (2018 census only) | 1002 |
iur
|
String | Urban rural indicator name (2018 census only) | Rural settlement |
iur_id
|
String | Urban rural indicator ID (2018 census only) | 21 |
region
|
String | The Regional Authority in which this address exists. Note: Regional Authorities are the top tier of local government in New Zealand. | Auckland Region |
region_id
|
String | Region ID (2018 census only) | 04 |
ta
|
String | The Territorial Authority in which this address exists. Territorial authorities are the second tier of local government in New Zealand. | Auckland |
ta_id
|
String | Territorial Authority ID (2018 census only) | 060 |
con
|
String | Constituency name (2018 census only) | Te Hiku Constituency |
con_id
|
String | Constituency ID (2018 census only) | 0101 |
maoricon
|
String | Maori Constituency name (2018 census only) | Okurei Maori Constituency |
maoricon_id
|
String | Maori Constituency ID (2018 census only) | 0402 |
ward
|
String | Ward name (2018 census only) | Banks Peninsula Ward |
ward_id
|
String | Ward ID (2018 census only) | 06016 |
cb
|
String | Community Board name (2018 census only) | Te Hiku Community |
cb_id
|
String | Community Board ID (2018 census only) | 00101 |
tasub
|
String | Territorial Authority Subdivision name (2018 census only) | Akaroa Subdivision |
tasub_id
|
String | Territorial Authority Subdivision ID (2018 census only) | 06019 |
landwater
|
String | Land/Water description (2018 census only) | Inlet |
landwater_id
|
String | Land/Water ID (2018 census only) | 22 |
address_line_1
|
String | First line of the non-suburb/city/postcode portion of the address | Unit 2 |
address_line_2
|
String | Second line of the non-suburb/city/postcode portion of the address. | 1703A State Highway 1 |
pxid
|
String | Unique address identifier. | 3-.1.1d.2.42.1T.2 |
success
|
Boolean | Indicates if the request was successful or not. | true |
Errors
Below are the possible errors that can be returned by the API.
- Validation error (1000)
- Key not found (1001)
- Key not provided (1002)
- Domain not registered with Addressfinder (1003)
- Secret not provided (1004)
- Direct API calls are not permitted on your current plan. (1005)
- Invalid credentials (1006)
- Secret should not be supplied (1008)
- The Addressfinder plugin has exceeded the number of allowed lookups, and is now suspended (1009)
- The record you are trying to load does not exist (1011)
- Domain parameter must not be included in a web request (1015)
- This domain has been blocked (1016)
- This service is not enabled on your current plan (1017)
- Your IP address has been blocked for these credentials (1018)
- HTTP Referer or Origin header record must be present when making a browser initiated request (1019)
- Your Addressfinder trial has ended (1020)
- Your Addressfinder trial has exceeded its allowed lookups (1021)
- Postal addresses are not enabled on your current plan (1022)
- Your Addressfinder plan is paused (1023)