Address metadata (Australia)

The address verification service returns useful information about each address.

For New Zealand, see the NZ metadata list.

For other countries, see the international metadata list.

Address

Params

Property	Type	Description
source	String	Determines the source of the addresses being searched and returned.
post_box	String	Return PO Box style addresses. This includes PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS and RSD. Used with the source filter above.
canonical	String	Return canonical and/or alias addresses - this allows for vanity suburbs, historic street names, and more.
state_codes	String	Filter the results according to the states or territories. Use a comma to separate multiple values.
max	Integer	The maximum number of results to return. A number between 1 and 15. The default is 10 results.

Metadata params

Property	Type	Description	Default value
source	String	Determines the source of the address and metadata returned.	gnaf,paf
GNAF		Returns the physical address and metadata from the GNAF address dataset (default).	gnaf
PAF		Returns postal address and metadata from the Australia Post postal address file.	paf
Combined		Returns the address and metadata from the dataset associated with the queried address.	gnaf,paf
gps	String	Request GPS coordinates for latitude and longitude be returned when available.	0
Yes		GPS coordinates wil be included in the response	1
No			0
census	String	Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response. Defaults to 2016 if omitted.
2016		to collect 2016 census related metadata	2016
2021		to collect 2021 census related metadata	2021

Metadata

Name	Type	Description	Example
id	String	The unique address identifier.	8097e3df-a3ab-43ad-bc66-22c8f5812361
full_address	String	Full address in the country specific format.	13 Neville Street, RYDE NSW 2112
street_number_1	String	The building number on the street.	1703
street_number_2	String	The upper bound when this is a ranged address. Returns null for single number addresses.	1705
lot_identifier	String	The specific lot on a site. This can be an alpha, number, or both.	3
site_name	String	The address element that identifies the name of a site or building.	Kenilworth Police Station
unit_identifier	String	The specific sub-dwelling. This can be an alpha, number, or both.	2
unit_type	String	Describes the category of a sub-dwelling.	Suite
level_number	String	The specific level within a multi-level building. This can be an alpha, number, or both.	3
level_type	String	Describes the level type.	Basement
street_name	String	The name of the street without the street type or suffix.	Queen
street_type	String	The street type.	Street
street_suffix	String	The suffix of the street.	North
street	String	The full name of the street.	Queen Street North
locality_name	String	The locality or suburb of this address.	KATOOMBA
state_territory	String	The state or territory where the address is located.	NSW
canonical_address	String	The canonical or official full address string associated with this address.	11-15 Neville Street, RYDE NSW 2112
canonical_address_id	String	The unique canonical address identifier. If the address is canonical, id is identical.	d70230a9-a3d8-402f-971e-1b798d00f2f5
postcode	String	The 4 digits postcode.	0983
address_line_1	String	First line of the address.	Unit 209
address_line_2	String	Second line of the address. This will be null for addresses without a unit/level number, etc.	274 Harbour Drive
address_line_combined	String	The combined address_line_1 and address_line_2.	Unit 209, 274 Harbour Drive
latitude	String	The latitude coordinate in WGS84 format.	-37.899031
longitude	String	The longitude coordinate in WGS84 format.	144.999530
dpid *	String	The Australia Post delivery point identifier. The source must be set to paf.	99119187
box_identifier *	String	The number of a portion of a PO Box address. The source must be set to paf or gnaf,paf.	123
box_type *	String	The type portion of a PO Box address (PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS, or RSD) The source must be set to paf or gnaf,paf.	PO Box
meshblock *	String	The meshblock identifier in which the address is located. The format is MB followed by a 2-digit year identifier and an 11-digit meshblock identifier. The source must be set to gnaf.	MB1610671120000
sa1_id *	String	The Statistical Area 1 identifier in which the address is located. The source must be set to gnaf.	12602159143
sa2_id *	String	The Statistical Area 2 identifier in which the address is located. The source must be set to gnaf.	126021591
gnaf_id *	String	The unique persistent identifier in the G_NAF database. The source must be set to gnaf.	GANSW705051429
legal_parcel_id *	String	The government legal property description. The source must be set to gnaf.	10//SP9489
lga_name *	String	The name of the Local Government Area in which the address is located. The source must be set to gnaf.	Bundaberg
lga_type_code *	String	The code relating to the type (or status) of the Local Government Area (Area A, Aboriginal Council AC, Borough B, City C, District Council DC, Municipality / Municipal Council M, Regional Council R or RegC, Rural City RC, Shire S, and Town T). The source must be set to gnaf.	DC
success	Boolean	Returns true if the service ran successfully.	true

Location

Params

Property	Type	Description
location_types	String	Show only locations of the supplied type. Use a comma to separate multiple values.
state_codes	String	Filter the results according to the states or territories. Use a comma to separate multiple values.
max	Integer	The maximum number of results to return. A number between 1 and 100. The default is 10 results.

Metadata

Property	Type	Description	Example
full_location	String	Full location string.	Mathers Road East, WALKERVILLE VIC 3959
location_type	String	The kind of location. Valid values include street, locality or state.	street
latitude	String	Latitude coordinate (in WGS84 format).	-38.77287906
longitude	String	Longitude coordinate (in WGS84 format).	146.10907797
street_name	String	Holds the name of the street. Note: This attribute response does not contain the street type.	Mathers
street_type	String	The type of street.	Road
street_suffix	String	The suffix of the street. Typically contains a compass direction.	East
street	String	The full street name. Note: This attribute response contains the street name, street type and street suffix.	Mathers Road East
locality_name	String	The locality/suburb of this address.	WALKERVILLE
state_territory	String	The Australian state or territory containing the location	VIC
postcode	String	The postcode assigned to a locality (for 'locality' locations), or to the locality a street is in (for 'street' locations).	3959
success	Boolean	Indicates if the request was successful or not.	true