Address Autocomplete API (AU)

Build
Send
Response
Errors

This page contains the technical API information for our Address Autocomplete service. Please visit our address autocomplete page if you are looking to learn more about the feature

This API is used to power the autocomplete capability of the widget. It can also be used to power your own custom autocomplete functionality, such as in a mobile or desktop app. If you want to call this API from a web browser, there are some special guidelines that you will need to follow.

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`
q *		String	The partial address being searched.
format *		String	The format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
gnaf		String	Returns physical addresses from the GNAF dataset (supplied by the Australian Government).
	Options Physical `1` Returns physical addresses.
au_paf		String	Returns postal addresses from the PAF dataset. These are addresses which Australia Post deliver mail to and StarTrack and eParcel deliver parcels to.
	Options Deliverable `1` Returns deliverable addresses.
post_box		String	Return PO Box style addresses. This includes `PO Box`, `Locked Bag`, `GPO Box`, `CMB`, `RMS`, `Care PO`, `MS` and `RSD`. Used with the au_paf=1 filter above.
	Options PO Boxes excluded `0` Set this option to exclude PO Box style addresses from your search results PO Boxes only `1` A rarely used option that returns only PO Box style addresses PO Boxes included Returns PO Box addresses with deliverable addresses
canonical		String	Return canonical and/or alias addresses - this allows for vanity suburbs, historic street names, and more. FAQ: What is the difference between canonical and alias addresses
	Options Canonical only `1` Alias addresses are not included in the search results Any Canonical and alias addresses are returned (most common option)
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` Matching terms in the returned addresses are highlighted. See the response specification for an example. No highlighting

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

Request URL

https://api.addressfinder.io/api/au/address/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
`full_address`	String	Full address string. FAQ: alias address vs canonical address	Unit 2, 21 Kent Road, DAPTO NSW 2530
`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.	a4c4f26d-7327-40cc-9d05-ca94bd94a354
`highlighted_full_address`	String	When highlighting is enabled, contains the full address string with highlighted matching terms.	Unit <span class=‘af_hl’>2</span>, <span class=‘af_hl’>21</span> <span class=‘af_hl’>Kent</span> <span class=‘af_hl’>Road</span>, DAPTO NSW 2530
`id`	String	The unique address identifier of the displayed address. As the displayed address can be an alias or canonical address, making use of the canonical_address_id is recommended.	c10cf706-2e2e-4fe1-887c-156e6118ab76
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

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