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.

Endpoint

Australia

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

Parameters

Parameter	Default	Description
`key`		Your unique licence key (find on Portal credentials) Required string
`secret`		Your unique secret key (find on Portal credentials). This required when calling API endpoints without a referer. Optional string
`format`	`json`	The required format of the response. Optional 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. Optional string
`gnaf_id`		Unique id from the G-NAF dataset. You must supply either an id, or a gnaf_id, or a dpid field. Optional string
`dpid`		Australia Post delivery point identifier. You must supply either an id, or a gnaf_id, or a dpid field. Optional string
`source`	`gnaf,paf`	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. Optional 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 Optional 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. Optional string
`census`	`2016`	Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response. Defaults to `2016` if omitted. Optional 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). Optional string

Responses

200 OK

Name	Type	Description	Example
`full_address`	string	Full address string.	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.	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.	d70230a9-a3d8-402f-971e-1b798d00f2f5
`latitude`	string	Latitude coordinate (in WGS84 format) from the G-NAF dataset, or PAF dataset (for PAF-only addresses).	-37.899031
`longitude`	string	Longitude coordinate (in WGS84 format) from the G-NAF dataset, or PAF dataset (for PAF-only addresses).	144.99953
`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 `2016` and `2021` census. Defaults to `2016` if not provided. Only returned when parameter `gnaf=1` supplied.	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 `2016` and `2021` census. Defaults to `2016` if not provided. Only returned when parameter `gnaf=1` supplied.	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 `2016` and `2021` census. Defaults to `2016` if not provided. Only returned when parameter `gnaf=1` supplied.	126021591
`gnaf_id`	string	The unique persistent identifier of the G-NAF address. Only returned when parameter `gnaf=1` supplied.	GANSW705051429
`dpid`	string	Australia Post delivery point identifier. Only returned on canonical addresses from Australia Post when parameter `paf=1` supplied.	99119187
`legal_parcel_id`	string	Government legal property description. Only returned when parameter `gnaf=1` supplied.	10//SP9489
`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

400 Bad request

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

See API Error Reference for details.