Australia address metadata

The address autocomplete service returns useful information about each address. On selection of an address, the widget can be configured to collect the information documented in the response spec below.

Metadata response specification

Field Name	Type	Description	Example
`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
`id`	String	The unique address identifier.	8097e3df-a3ab-43ad-bc66-22c8f5812361
`success`	Boolean	Returns `true` if the service ran successfully.	`true`

Autocomplete parameters (address_params)

This table contains parameters and options that can be used to control which addresses are searched and returned for display in the drop down.

Property	Type	Description	Value
`source`	String	Determines the source of the addresses searched by the service.
GNAF		Searches and returns physical/legal addreses from the GNAF dataset (default).	`gnaf`
PAF		Searches and returns postal addresses from the Australia Post PAF.	`paf`
Combined		Searches and returns addresses from both the GNAF and PAF datasets.	`gnaf,paf`
`post_box`	String	Return PO Box type addresses. This includes PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS and RSD. Used with the source filter above.
Exclude		Excludes PO Box type addresses from the search results.	`0`
Include		Omit to include PO Box type addresses in the search results (default).
`canonical`	String	Controls the inclusion/exclusion of alias addresses in the search results.
Exclude		Excludes alias addresses from the search results.	`0`
Include		Omit to include alias addresses in the search results (default).
`state_codes`	String	Controls filtering of results according to specified State or Territory abbreviations.
Filter		Options include ACT, NSW, NT, QLD, SA, TAS, VIC, WA. Comma separate multiple values.	Eg. `VIC`
All		Omit to search addresses from across the whole country (default).
`max`	Integer	The maximum number of search results to return. A number between 1 and 100 (default is 10).	`10`

Metadata parameters (address_metadata_params)

This table contains parameters and options that control the source of the address and metadata attributes returned on selection of an address.

Property	Type	Description	Value
`source`	String	Determines the source of the address and metadata returned.
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`
Include		GPS coordinates wil be included in the response.	`1`
Exclude		Omit to exclude GPS coordinates in the metadata response (default).
`census`	String	Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response.
2016		Collect data relating to the 2016 census.	`2016`
2021		Collect data relating to the 2021 census (default).	`2021`