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	Description	Test Value
`key`	Your unique licence key (find on Portal credentials) Type: `string` `required`
`secret`	Your unique secret key from Portal Credentials. You can also pass your secret key into the `Authorization` header of the request. Only required for server-to-server calls. Type: `string`
`q`	The partial address being searched Type: `string`
`format`	The format of the response. Default value: `json` Type: `string`
`source`	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. Default value: `GNAF,PAF` Type: `string`
`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 Type: `string`
`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) Type: `string`
`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 Type: `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. Type: `string`
`max`	The maximum number of results to return. The default is 10 results. Default value: `10` Type: `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 Type: `string`
`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). Type: `string`

Responses

200 OK

Name	Description	Example
`completions`	Type: `array`	-
`full_address`	Full address string. Type: `string`	Unit 2, 21 Kent Road, DAPTO NSW 2530
`id`	The unique address identifier. This ID will change following a data refresh. Type: `string`	c10cf706-2e2e-4fe1-887c-156e6118ab76
`canonical_address_id`	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. Type: `string`	a4c4f26d-7327-40cc-9d05-ca94bd94a354
`highlighted_full_address`	When highlighting is enabled, contains the full address string with highlighted matching terms. Type: `string`	Unit 2, 21 Kent Road, DAPTO NSW 2530
`success`	if the request completed successfully Type: `boolean`	true

400 Bad request

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

See API Error Reference for details.