Location Metadata API (AU)

Build
Send
Response
Errors

The Location Metadata API is used to load the full metadata associated with a location (street, suburb or state) selected from the Location Autocomplete API

Build the 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 location id obtained from the Location Autocomplete API.
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

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

Request URL

https://api.addressfinder.io/api/au/location/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.

Field Name	Type	Description	Example
`full_location`	String	Full location string.	Mathers Road East, WALKERVILLE VIC 3959
`location_type`	String	The kind of location. Valid values include street, locality or state.	street
`latitude`	String	Latitude coordinate (in WGS84 format).	-38.77287906
`longitude`	String	Longitude coordinate (in WGS84 format).	146.10907797
`street_name`	String	Holds the name of the street. Note: This attribute response does not contain the street type.	Mathers
`street_type`	String	The type of street.	Road
`street_suffix`	String	The suffix of the street. Typically contains a compass direction.	East
`street`	String	The full street name. Note: This attribute response contains the street name, street type and street suffix.	Mathers Road East
`locality_name`	String	The locality/suburb of this address.	WALKERVILLE
`state_territory`	String	The Australian state or territory containing the location	VIC
`postcode`	String	The postcode assigned to a locality (for 'locality' locations), or to the locality a street is in (for 'street' locations).	3959
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

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