a
Canonical address as supplied by Land Information New Zealand or NZ Post.
postal
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.
building_name
Holds the building or property name.
unit_type
Describes the category of a sub-dwelling.
unit_identifier
Identifies a specific sub dwelling. Can be alpha, number or a combination.
floor
The level number and level type in a multi-story building.
number
The street number of the address. Also populated with the box number for PO Box type addresses.
alpha
Holds the alpha component of a street number. In the address 1B High Street, B is the alpha.
street
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.
street_name
Holds the name of the street as supplied by Land Information New Zealand or NZ Post.
post_street
Holds the street name and type from NZ Post, it will be omitted if the address is not delivered to by NZ Post.
post_street_name
Holds the street name from NZ Post, it will be omitted if the address is not delivered to by NZ Post.
street_type
The type of street.
street_suffix
The suffix of the street. Typically contains a compass direction.
suburb
The suburb or locality of the address as assigned by Land Information New Zealand.
city
The city, town or locality name as assigned by Land Information New Zealand.
box_type
The type of PO Box/CMB/Private Bag/Counter Delivery.
lobby_name
The name of the NZ Post outlet or Agency outlet where the PO Box, Private Bag or Counter Delivery is located.
rd_number
The rural delivery number assigned by NZ Post to a rural address.
post_suburb
Name of the suburb when supplied by NZ Post.
mailtown
Name of the town/city when supplied by NZ Post.
postcode
Holds the four digit postcode.
dpid
A unique reference number assigned to each delivery address by NZ Post.
primary_parcel_id
The unique identifier of the portion of land associated with the selected address.
aims_address_id
The unique identifier from Land Information New Zealand (LINZ).
x
Longitude coordinate (in WGS84 format).
y
Latitude coordinate (in WGS84 format).
meshblock
The meshblock identifier for the requested census dataset (see census
parameter). If not specified, the Census parameter will default to 2018.
sa1_id
Statistical area 1 (2018 census only)
sa2_id
Statistical area 2 ID (2018 census only)
sa2
Statistical area 2 name (2018 census only)
rural
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.
ur
Urban rural name (2018 census only)
ur_id
Urban rural ID (2018 census only)
iur
Urban rural indicator name (2018 census only)
iur_id
Urban rural indicator ID (2018 census only)
region
The Regional Authority in which this address exists. Note: Regional Authorities are the top tier of local government in New Zealand.
region_id
Region ID (2018 census only)
ta
The Territorial Authority in which this address exists. Territorial authorities are the second tier of local government in New Zealand.
ta_id
Territorial Authority ID (2018 census only)
con
Constituency name (2018 census only)
con_id
Constituency ID (2018 census only)
maoricon
Maori Constituency name (2018 census only)
maoricon_id
Maori Constituency ID (2018 census only)
ward
Ward name (2018 census only)
ward_id
Ward ID (2018 census only)
cb
Community Board name (2018 census only)
cb_id
Community Board ID (2018 census only)
tasub
Territorial Authority Subdivision name (2018 census only)
tasub_id
Territorial Authority Subdivision ID (2018 census only)
landwater
Land/Water description (2018 census only)
landwater_id
Land/Water ID (2018 census only)
address_line_1
First line of the non-suburb/city/postcode portion of the address
address_line_2
Second line of the non-suburb/city/postcode portion of the address.
pxid
Unique address identifier.
success
Indicates if the request was successful or not.