Address Metadata API (AU)

Build
Send
Response
Errors

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

Build the GET request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Field Name	Value	Type	Description
key *		String	Your unique licence key (find on Portal credentials)
secret *		String	Your unique secret key (find on Portal credentials). Alternatively, you can pass your secret key into the Authorization header of the request as such: `Authorization: your-secret`. FAQ: Learn more about authenticating direct API calls in request headers
format *		String	The format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
id		String	Unique address id obtained from the Address Autocomplete API. You must supply either an id, or a gnaf_id, or a dpid field.
gnaf_id		String	Unique id from the G-NAF dataset. You must supply either an id, or a gnaf_id, or a dpid field.
dpid		String	Australia Post delivery point identifier. You must supply either an id, or a gnaf_id, or a dpid field.
source		String	Determines the source of the address and metadata returned.
	Options GNAF `gnaf` Returns the physical address and metadata from the GNAF address dataset (default). PAF `paf` Returns postal address and metadata from the Australia Post postal address file. Combined `gnaf,paf` Returns the address and metadata from the dataset associated with the queried address.
gps		String	Request GPS coordinates for `latitude` and `longitude` be returned when available
	Options Yes `1` GPS coordinates wil be included in the response No `0`
domain		String	Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. FAQ: learn more about the domain parameter
census		String	Used to determine which census year’s statistical area identifiers (Meshblock, SA1 & SA2) will be returned in the response. Defaults to `2016` if omitted.
	Options 2016 `2016` to collect 2016 census related metadata 2021 `2021` to collect 2021 census related metadata
ascii		Integer	A filter that replaces macron-containing characters with their ASCII counterparts. It doesn't exclude addresses with macron characters from the results, it translates these characters into their corresponding English equivalents within the addresses. Use when your systems are having issues processing macron-containing addresses.
	Options Converted `1` Converts the response to ASCII. Original Leaves the response as is, potentially containing macrons or non-ascii characters.

* Parameters marked with an asterisk are mandatory for this API call.

Request URL

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

      
        /* Click the button above to see a real API response here */
        {
          "success": true
        }

Response Specification

The API response will include all the attributes listed below in the format requested in the API request. Empty attributes for the matched address will be returned with a null value.

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.

Field Name	Type	Description	Example
`full_address` GNAF PAF GNAF,PAF	String	Full address string. FAQ: alias address vs canonical address.	13 Neville Street, RYDE NSW 2112
`id` GNAF PAF GNAF,PAF	String	The unique address identifier. This ID will change following a data refresh.	8097e3df-a3ab-43ad-bc66-22c8f5812361
`canonical_address` GNAF PAF 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 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 GNAF,PAF	String	Latitude coordinate (in WGS84 format).	-37.899031
`longitude` GNAF PAF GNAF,PAF	String	Longitude coordinate (in WGS84 format).	144.999530
`lot_identifier` GNAF PAF GNAF,PAF	String	Identifies a specific lot on a site. Can be an alpha, number or a combination.	3
`box_identifier` PAF GNAF,PAF	String	The number portion of a PO Box address	123
`box_type` PAF GNAF,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 GNAF,PAF	String	Holds the address element that identifies the name of a site or building.	Kenilworth Police Station
`level_type` GNAF PAF GNAF,PAF	String	Describes the level type within a multi-level building.	Basement
`level_number` GNAF PAF 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 GNAF,PAF	String	Describes the category of a sub-dwelling.	Suite
`unit_identifier` GNAF PAF GNAF,PAF	String	Identifies a specific sub-dwelling. Can be an alpha, number or a combination.	2
`street_number_1` GNAF PAF GNAF,PAF	String	The number of the building on the street.	1703
`street_number_2` GNAF PAF 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 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 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 GNAF,PAF	String	The type of street.	Street
`street_suffix` GNAF PAF GNAF,PAF	String	The suffix of the street. Typically contains a compass direction.	North
`locality_name` GNAF PAF GNAF,PAF	String	The locality/suburb of this address.	KATOOMBA
`state_territory` GNAF PAF GNAF,PAF	String	The Australian state or territory where the address is located.	NSW
`postcode` GNAF PAF GNAF,PAF	String	Holds the four digit postcode.	0983
`address_line_1` GNAF PAF GNAF,PAF	String	First line of the non-locality/state/postcode portion of the address	Unit 209
`address_line_2` GNAF PAF 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 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 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

Errors

Below are the possible errors that can be returned by the API.