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 | String | Full address string. FAQ: alias address vs canonical address. | 13 Neville Street, RYDE NSW 2112 |
id | String | The unique address identifier. This ID will change following a data refresh. | 8097e3df-a3ab-43ad-bc66-22c8f5812361 |
canonical_address | 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 | 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 | String | Latitude coordinate (in WGS84 format). | -37.899031 |
longitude | String | Longitude coordinate (in WGS84 format). | 144.999530 |
lot_identifier | String | Identifies a specific lot on a site. Can be an alpha, number or a combination. | 3 |
box_identifier | String | The number portion of a PO Box address | 123 |
box_type | 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 | String | Holds the address element that identifies the name of a site or building. | Kenilworth Police Station |
level_type | String | Describes the level type within a multi-level building. | Basement |
level_number | String | Identifies a specific level within a multi-level building. Can be an alpha, number or a combination. | 3 |
unit_type | String | Describes the category of a sub-dwelling. | Suite |
unit_identifier | String | Identifies a specific sub-dwelling. Can be an alpha, number or a combination. | 2 |
street_number_1 | String | The number of the building on the street. | 1703 |
street_number_2 | String | Holds the upper bound when this is a ranged address. For single number addresses this field is null | 1705 |
street | 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 | String | Holds the name of the street. Note: This attribute does not include the street type or suffix. | Queen |
street_type | String | The type of street. | Street |
street_suffix | String | The suffix of the street. Typically contains a compass direction. | North |
locality_name | String | The locality/suburb of this address. | KATOOMBA |
state_territory | String | The Australian state or territory where the address is located. | NSW |
postcode | String | Holds the four digit postcode. | 0983 |
address_line_1 | String | First line of the non-locality/state/postcode portion of the address | Unit 209 |
address_line_2 | 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 |
success | Boolean | Indicates if the request was successful or not. | true |
dpid | String | Australia Post delivery point identifier. | 99119187 |
lga_name | 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 | 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 | String | Government legal property description. | 10//SP9489 |
meshblock | 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.Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided. | MB1610671120000 |
sa1_id | 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. Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided. | 12602159143 |
sa2_id | 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. Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided. | 126021591 |
gnaf_id | 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.