Address Autocomplete API

The AU Address Autocomplete API is used to search the AU Addressfinder database to return closely matching addresses which can then be selected from by the user. This API works in tandem with the AU Address Metadata API which is used to load the metadata associated with the selected address.

Endpoint

Australia

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

Parameters

Parameter	Default	Description	Test Value
key		Your unique licence key (find on Portal credentials) Required string
secret		Your unique secret key (find on Portal credentials). This is required when calling API endpoints without a referer. Optional string
q		The partial address being searched Optional string
format	json	The format of the response. Optional string	-- Select --jsonxml
source	gnaf,paf	Determines the source of the addresses being searched and returned. GNAF - Returns physical addresses from the GNAF address dataset. PAF - Returns postal addresses, including PO Box type addresses, from the Australia Post postal address file. GNAF,PAF - Returns addresses from either of the PAF or GNAF address datasets. Optional string	-- Select --gnaf,pafgnafpaf
post_box		Return PO Box style addresses. This includes PO Box, Locked Bag, GPO Box, CMB, RMS, Care PO, MS and RSD. Used with the source filter above: 0 - Set this option to exclude PO Box style addresses from your search results 1 - A rarely used option that returns only PO Box style addresses Omit to return PO Box addresses with deliverable addresses Optional string	-- Select --01
canonical		Return canonical and/or alias addresses - this allows for vanity suburbs, historic street names, and more: 1 - Alias addresses are not included in the search results Omit to return canonical and alias addresses are returned (most common option) Optional string	-- Select --1
state_codes		Filter the results according to the states or territories. Use a comma to separate multiple values: ACT - Only returns addresses from Australian Capital Territory NSW - Only returns addresses from New South Wales NT - Only returns addresses from Northern Territory QLD - Only returns addresses from Queensland SA - Only returns addresses from South Australia TAS - Only returns addresses from Tasmania VIC - Only returns addresses from Victoria WA - Only returns addresses from Western Australia OT - Only returns addresses from Other Territories Optional string
domain		Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. Optional string
max	10	The maximum number of results to return. The default is 10 results. Optional integer
highlight		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: 1 - Matching terms in the returned addresses are highlighted. Omit to not return additional highlighted_a property Optional string	-- Select --1
ascii		Set to 1 to reformat special characters like macrons and other accents characters with their ASCII equivalent (e.g. Pōneke and Café will be returned as Poneke and Cafe). Optional string	-- Select --1

Responses

200 OK

Name	Type	Description	Example
completions	array		-
full_address	string	Full address string.	Unit 2, 21 Kent Road, DAPTO NSW 2530
id	string	The unique address identifier. This ID will change following a data refresh.	c10cf706-2e2e-4fe1-887c-156e6118ab76
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 2, 21 Kent Road, DAPTO NSW 2530
success	boolean	if the request completed successfully	true

400 Bad request

Name	Type	Description	Example
completions	array	An empty array will be returned due to the error	-
error_code	string	A unique numerical value identifying the error that occured	1004
message	string	An informative message describing the error that occured	Secret not provided
success	boolean	Indicates that the result was a failure	false

See API Error Reference for details.