Address Autocomplete API (AU)

Build
Send
Response
Errors

This API is used to power the autocomplete capability of the AddressFinder 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.

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

Build the request URL

Use the form below to build your request URL from the parameters. A URL string will be generated from these parameters and sent to the API in order to provide insight into how the API works and the responses it returns.

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)
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

        
          /* 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.

Code	Error	Cause	Resolution
`1000`	Validation error	Returned when one of the supplied parameters is missing or incorrect. The response will contain a message attribute which explains the cause of the validation error. An example JSON response is shown below for a request which failed to include the `q` parameter. `{ completions: [ ], message: 'Q can not be blank', error_code: '1000' }`	Check that the supplied parameters contain valid values, and that the mandatory parameters have been included.
`1001`	Key not found	Returned when the key included in your API call cannot be found in our database. This will normally happen when you make a copy ’n paste error.	Compare the key included in your API call with the key listed in the AddressFinder Portal credentials. Also confirm there are no additional spaces or characters in your API call.
`1002`	Key not provided	Returned when you fail to send through your key with each request. The key is a mandatory parameter.	Check that you are using the correct parameter name `key`.
`1003`	Domain not registered with AddressFinder	The URL of the website where you are using the AddressFinder widget is not listed correctly in the allowed domains on the AddressFinder Portal. *Here are a few ways this could have happened:* The website domain not added to the portal: Domain listed: `some-other-site.com`, Website URL: `my-site.com` The website domain is added with 'www' but the website URL doesn't contain 'www': Domain listed: `www.my-site.com`, Website URL:`my-site.com` The website domain is added, but it has the wrong prefix (also known as a subdomain): Domain listed: `staging.my-site.com`, Website URL: `production.my-site.com`	Login to the AddressFinder Portal and add the domain of your website to your account. Adding the root domain, which means the domain without any prefix, will allow queries from all subdomains. For example, if you would like to use the widget on `staging.my-site.com` and `production.my-site.com`, all you need to do is add `my-site.com` in the Portal. Note: in this case, all lookups will be recorded under `my-site.com`
`1004`	Secret not provided	Returned when you fail to send through your secret with an API call. Can also occur when using the widget and the HTTP `Referer` header is not included.	Include the secret listed in the AddressFinder Portal credentials in your API call. When using the widget, you must load the page from a web server (e.g. localhost) and not a `file://` scheme.
`1005`	Direct API calls are not permitted on your current plan.	Returned if you try to call the API and you are on either a Free or Agile plan. These plan types provide access to the JavaScript Widget and plugins only.	Upgrade to a Business plan. Visit the AddressFinder Portal to change plan.
`1006`	Invalid credentials	Returned when the supplied key and/or secret value are incorrect. This will normally happen when you make a copy ’n paste error.	Compare the key and secret included in your API call with the values listed on the AddressFinder Portal credentials page. Also confirm there are no additional spaces or characters in your API call.
`1008`	Secret should not be supplied	This is a safety check to ensure that the secret parameter has not been included when making requests from your web browser. You should never include the secret on any web page.	The secret should be used for server-to-server API calls only.
`1009`	The AddressFinder plugin has exceeded the number of allowed lookups, and is now suspended	Returned when your account (free plans only) has hit its 100% usage limit for the billing period.	Visit the AddressFinder Portal and switch to a Paid plan. Alternatively wait until the end of the month when suspended accounts are automatically reactivated.
`1010`	Account not authorised to use this API	Returned when you make an API call that you are not permitted to use	Contact AddressFinder support to request access to this API.
`1011`	The record you are trying to load does not exist	Returned when the supplied address identifier cannot be found. This can happen when a stale identifier is included in the API call.	Do not save address identifiers in your database, as they are transient and may change after each database update.
`1012`	Account not authorised to use this API	Returned when you make an API call that you are not permitted to use	Contact AddressFinder support to request access to this API.
`1013`	This API has been discontinued	This API has been discontinued	Contact AddressFinder support to discuss alternatives.
`1015`	Domain parameter must not be included in a web request	You have included a domain parameter in your browser based API call. The domain parameter is for direct API calls only.	Remove the domain parameter from your web request.
`1016`	This domain has been blocked	These credentials are not permitted to be used on this domain.	Contact AddressFinder support to discuss removing the block.
`1017`	This service is not enabled on your current plan	You have attempted to use an AddressFinder service that is not enabled on your current plan.	Visit the AddressFinder Portal to change plan.
`1018`	Your IP address has been blocked for these credentials	This service has been configured to only allow access from defined IP addresses.	Visit the AddressFinder Portal and add your IP address to the IP Allow List.
`1019`	HTTP Referer or Origin header record must be present when making a browser initiated request	You have attempted to use the AddressFinder widget from a browser that does not include the referrer or origin headers along with each request.	Confirm that this request was sent from a valid web server (not the local filesystem), and that you do not have browser plugins interfering with the request.
`1020`	Your AddressFinder trial has ended	Returned when the trial term has ended.	Log into the AddressFinder Portal and upgrade your account to a suitable plan.
`1021`	Your AddressFinder trial has exceeded its allowed lookups	Returned when you have exceeded the number of lookups permitted on the trial plan.	Log into the AddressFinder Portal and upgrade your account to a suitable plan.
`1022`	Postal addresses are not enabled on your current plan	You have attempted to query postal addresses, this service is not included in your current plan.	You can use our service without specifying postal addresses. For Australia, use the param `gnaf:1` (and remove `au_paf:1`). For New Zealand, remove `delivered:1` and `post_box:1`. If you would like to continue using postal addresses, log into the AddressFinder Portal and upgrade your account to a suitable plan.