Address Metadata API

The AU Address Metadata API is used to load the full metadata associated with an AU Address selected from the AU Address Autocomplete API.

Learn more about the Address Verification service.

Response Key

GNAF	Returned (if present) when searching the `gnaf` database.
PAF	Returned (if present) when searching the `paf` database.
GNAF-PAF	Returned (if present) when searching the combined `gnaf,paf` datasets.

Endpoint

Australia

https://api.addressfinder.io/api/au/address/metadata

Parameters

Parameter	Description	Test Value
`key`	Your unique licence key (find on Portal credentials) Type: `string` `required`
`secret`	Your unique secret key from Portal Credentials. You can also pass your secret key into the `Authorization` header of the request. Only required for server-to-server calls. Type: `string`
`format`	The required format of the response. Default value: `json` Type: `string`
`id`	Unique address identifier obtained from the Address Autocomplete API. You must supply either an id, or a gnaf_id, or a dpid field. Type: `string`
`gnaf_id`	Unique id from the G-NAF dataset. You must supply either an id, or a gnaf_id, or a dpid field. Type: `string`
`dpid`	Australia Post delivery point identifier. You must supply either an id, or a gnaf_id, or a dpid field. Type: `string`
`source`	Determines the source of the address and metadata returned.. `GNAF` - Returns physical addresses from the GNAF address dataset. `PAF` - Returns postal addresses, including PO Box type addresses, from the Australia Post postal address file. `GNAF,PAF` - Returns addresses from either of the PAF or GNAF address datasets. Default value: `GNAF,PAF` Type: `string`
`gps`	Request GPS coordinates for `latitude` and `longitude` be returned when available: `1` - GPS coordinates wil be included in the response Omit to GPS coordinates Type: `string`
`domain`	Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. Type: `string`
`census`	Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response. Defaults to `2016` if omitted. Default value: `2016` Type: `integer`
`ascii`	Set to `1` to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. Pōneke and Café will be returned as Poneke and Cafe). Type: `string`

Responses

200 OK

Name	Description	Example
`full_address`	Full address string. gnaf paf gnaf-paf Type: `string`	13 Neville Street, RYDE NSW 2112
`id`	The unique address identifier. This ID will change following a data refresh. gnaf paf gnaf-paf Type: `string`	8097e3df-a3ab-43ad-bc66-22c8f5812361
`canonical_address`	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. gnaf paf gnaf-paf Type: `string`	11-15 Neville Street, RYDE NSW 2112
`canonical_address_id`	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. gnaf paf gnaf-paf Type: `string`	d70230a9-a3d8-402f-971e-1b798d00f2f5
`latitude`	Latitude coordinate (in WGS84 format) from the G-NAF dataset, or PAF dataset (for PAF-only addresses). gnaf paf gnaf-paf Type: `string`	-37.899031
`longitude`	Longitude coordinate (in WGS84 format) from the G-NAF dataset, or PAF dataset (for PAF-only addresses). gnaf paf gnaf-paf Type: `string`	144.99953
`lot_identifier`	Identifies a specific lot on a site. Can be an alpha, number or a combination. gnaf paf gnaf-paf Type: `string`	3
`box_identifier`	The number portion of a PO Box address gnaf paf gnaf-paf Type: `string`	123
`box_type`	The type portion of a PO Box address, including `PO Box`, `Locked Bag`, `GPO Box`, `CMB`, `RMS`, `Care PO`, `MS` and `RSD` gnaf paf gnaf-paf Type: `string`	PO Box
`site_name`	Holds the address element that identifies the name of a site or building. gnaf paf gnaf-paf Type: `string`	Kenilworth Police Station
`level_type`	Describes the level type within a multi-level building. gnaf paf gnaf-paf Type: `string`	Basement
`level_number`	Identifies a specific level within a multi-level building. Can be an alpha, number or a combination. gnaf paf gnaf-paf Type: `string`	3
`unit_type`	Describes the category of a sub-dwelling. gnaf paf gnaf-paf Type: `string`	Suite
`unit_identifier`	Identifies a specific sub-dwelling. Can be an alpha, number or a combination. gnaf paf gnaf-paf Type: `string`	2
`street_number_1`	The number of the building on the street. gnaf paf gnaf-paf Type: `string`	1703
`street_number_2`	Holds the upper bound when this is a ranged address. For single number addresses this field is `null` gnaf paf gnaf-paf Type: `string`	1705
`street`	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. gnaf paf gnaf-paf Type: `string`	Queen Street North
`street_name`	Holds the name of the street. Note This attribute does not include the street type or suffix. gnaf paf gnaf-paf Type: `string`	Queen
`street_type`	The type of street. gnaf paf gnaf-paf Type: `string`	Street
`street_suffix`	The suffix of the street. Typically contains a compass direction. gnaf paf gnaf-paf Type: `string`	North
`locality_name`	The locality/suburb of this address. gnaf paf gnaf-paf Type: `string`	KATOOMBA
`state_territory`	The Australian state or territory where the address is located. gnaf paf gnaf-paf Type: `string`	NSW
`postcode`	Holds the four digit postcode. gnaf paf gnaf-paf Type: `string`	0983
`address_line_1`	First line of the non-locality/state/postcode portion of the address gnaf paf gnaf-paf Type: `string`	Unit 209
`address_line_2`	Second line of the non-locality/state/postcode portion of the address. This will be `null` for addresses without a unit/level/etc number. gnaf paf gnaf-paf Type: `string`	274 Harbour Drive
`success`	Indicates if the request was successful or not. gnaf paf gnaf-paf Type: `boolean`	true
`dpid`	Australia Post delivery point identifier. Only returned on canonical addresses from Australia Post when parameter `paf=1` supplied. paf Type: `string`	99119187
`gnaf_id`	The unique persistent identifier of the G-NAF address. Only returned when parameter `gnaf=1` supplied. gnaf Type: `string`	GANSW705051429
`legal_parcel_id`	Government legal property description. Only returned when parameter `gnaf=1` supplied. gnaf Type: `string`	10//SP9489
`meshblock`	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 `2016` and `2021` census. Defaults to `2016` if not provided. Only returned when parameter `gnaf=1` supplied. gnaf Type: `string`	MB1610671120000
`sa1_id`	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 `2016` and `2021` census. Defaults to `2016` if not provided. Only returned when parameter `gnaf=1` supplied. gnaf Type: `string`	12602159143
`sa2_id`	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 `2016` and `2021` census. Defaults to `2016` if not provided. Only returned when parameter `gnaf=1` supplied. gnaf Type: `string`	126021591

400 Bad request

Name	Description	Example
`completions`	An empty array will be returned due to the error Type: `array`	-
`error_code`	A unique numerical value identifying the error that occured Type: `string`	1004
`message`	An informative message describing the error that occured Type: `string`	Secret not provided
`success`	Indicates that the result was a failure Type: `boolean`	false

See API Error Reference for details.