What attributes are returned from the widget/Metadata API?

Key

GNAF Returned (if present) when searching the gnaf database.

PAF Returned (if present) when searching the au_paf database.

Field Name	Type	Description	Example
`full_address` GNAF PAF	String	Full address string. FAQ: alias address vs canonical address.	13 Neville Street, RYDE NSW 2112
`id` GNAF PAF	String	The unique address identifier. This ID will change following a data refresh.	8097e3df-a3ab-43ad-bc66-22c8f5812361
`canonical_address` GNAF PAF	String	The canonical or official full address string associated with this address. Can differ from the full_address in either street number, locality name or state name. FAQ: alias address vs canonical address.	11-15 Neville Street, RYDE NSW 2112
`canonical_address_id` GNAF PAF	String	The ID of the canonical or official address associated with this search result. Note: The ID and Canonical Address ID will be identical when the search result is canonical. FAQ: alias address vs canonical address.	d70230a9-a3d8-402f-971e-1b798d00f2f5
`latitude` GNAF PAF	String	Latitude coordinate (in WGS84 format).	-37.899031
`longitude` GNAF PAF	String	Longitude coordinate (in WGS84 format).	144.999530
`lot_identifier` GNAF PAF	String	Identifies a specific lot on a site. Can be an alpha, number or a combination.	3
`box_identifier` PAF	String	The number portion of a PO Box address	123
`box_type` PAF	String	The type portion of a PO Box address, including `PO Box`, `Locked Bag`, `GPO Box`, `CMB`, `RMS`, `Care PO`, `MS` and `RSD`	PO Box
`site_name` GNAF PAF	String	Holds the address element that identifies the name of a site or building.	Kenilworth Police Station
`level_type` GNAF PAF	String	Describes the level type within a multi-level building.	Basement
`level_number` GNAF PAF	String	Identifies a specific level within a multi-level building. Can be an alpha, number or a combination.	3
`unit_type` GNAF PAF	String	Describes the category of a sub-dwelling.	Suite
`unit_identifier` GNAF PAF	String	Identifies a specific sub-dwelling. Can be an alpha, number or a combination.	2
`street_number_1` GNAF PAF	String	The number of the building on the street.	1703
`street_number_2` GNAF PAF	String	Holds the upper bound when this is a ranged address. For single number addresses this field is `null`	1705
`street` GNAF PAF	String	Holds the full name of the street. This attribute is a composite of the street name, the street type, and the street suffix if present.	Queen Street North
`street_name` GNAF PAF	String	Holds the name of the street. Note: This attribute does not include the street type or suffix.	Queen
`street_type` GNAF PAF	String	The type of street.	Street
`street_suffix` GNAF PAF	String	The suffix of the street. Typically contains a compass direction.	North
`locality_name` GNAF PAF	String	The locality/suburb of this address.	KATOOMBA
`state_territory` GNAF PAF	String	The Australian state or territory where the address is located.	NSW
`postcode` GNAF PAF	String	Holds the four digit postcode.	0983
`address_line_1` GNAF PAF	String	First line of the non-locality/state/postcode portion of the address	Unit 209
`address_line_2` GNAF PAF	String	Second line of the non-locality/state/postcode portion of the address. This will be `null` for addresses without a unit/level/etc number.	274 Harbour Drive
`address_line_combined` GNAF PAF	String	A combination of the first and second lines of the non-locality/state/postcode portion of the address.	Unit 209, 274 Harbour Drive
`success` GNAF PAF	Boolean	Indicates if the request was successful or not.	true
`dpid` PAF	String	Australia Post delivery point identifier.	99119187
`lga_name` GNAF	String	The name of the Local Government Area in which the address is located. These values are provided by the ABS and are an approximation of the gazetted local government boundaries. Code example - collect LGA data	Bundaberg
`lga_type_code` GNAF	String	The code relating to the type (or status) of the Local Government Area. Codes used are 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`.	DC
`legal_parcel_id` GNAF	String	Government legal property description.	10//SP9489
`meshblock` GNAF	String	The meshblock identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census. The format is `MB`, followed by a 2 digit year identifier, followed by the 11 digit meshblock identifier.	MB1610671120000
`sa1_id` GNAF	String	The statistical area (SA1) identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census.	12602159143
`sa2_id` GNAF	String	The statistical area (SA2) identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census.	126021591
`gnaf_id` GNAF	String	The unique persistent identifier of the G-NAF address.	GANSW705051429

* Attributes marked with an asterisk will always be present in a successful API response.