Location Autocomplete API (AU)

Build
Send
Response
Errors

This API lets you search for streets, suburbs and/or states (we call these locations). This API works in tandem with the Location Metadata API which is used to collect the metadata associated with the selected location.

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
q *		String	The query string to be matched with the location.
format *		String	The format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
location_types		String	Show only locations of the supplied type. Use a comma to separate multiple values.
	Options Street `street` Locality / Suburb `locality` State `state`
state_codes		String	Filter the results according to the states or territories. Use a comma to separate multiple values.
	Options Australian Capital Territory `ACT` New South Wales `NSW` Northern Territory `NT` Queensland `QLD` South Australia `SA` Tasmania `TAS` Victoria `VIC` Western Australia `WA` Other territories `OT`
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
max		Integer	The maximum number of results to return. A number between 1 and 100. The default is 10 results.
highlight		Integer	Returns an additional attribute in the response called `highlighted_a`. This attribute wraps the matching terms in the address with `<span class='af_hl'></span>` in order to highlight those terms.
	Options Highlighted `1`

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

Request URL

https://api.addressfinder.io/api/au/location/autocomplete/

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

Response Specification

The API response will contain all the addresses and associated IDs (pxid) in the format requested in the API request.

Field Name	Type	Description	Example
`id`	String	The unique location identifier. This ID will change following a data refresh.	59a68aa3-0b46-4cbf-8817-e28e5dea3cad
`full_location`	String	Full location string.	Martin Street, OUYEN VIC 3490
`state_territory`	String	The Australian state or territory containing the location.	VIC
`location_type`	String	The kind of location. Valid values include street, locality or state.	street
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

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