Address Autocomplete API

This API is used to power the autocomplete capability of the Addressfinder JS widget and integrations. It can also be used to power your own custom autocomplete functionality, such as in a mobile or desktop app. This API works in tandem with the Address Metadata API which is used to collect the metadata associated with the selected address. Replace country in the path with the ISO 3166 alpha-2 code of the country you are searching in. Supported countries include: au, be, ca, cz, dk, fr, de, ie, nz, nl, pt, sg, es, se, gb, us.

Endpoint

International

https://api.addressfinder.io/api/{country}/address/v2/autocomplete

Parameters

Parameter	Description	Test Value
`country`	ISO 3166 alpha-2 country code. Type: `string` `required`
`key`	Your unique Addressfinder license key. 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. Max length 200 characters. Type: `string` `required`
`format`	The format of the response. Default value: `json` Type: `string`
`domain`	Used to identify in the Addressfinder Portal which of your services is calling the API for activity monitoring purposes. The domain needs to be registered in the Portal. Type: `string`
`max`	The maximum number of results to return. Between 1 and 15 (inclusive). Default value: `10` Type: `integer`

Responses

200 A list of address completions

Name	Description	Example
`completions`	Type: `array`	-
`id`	The unique address identifier. Type: `string`	_wEzMQD-UiYLas2j_kKyVwD-SRj_AcOp9f8ENzc3MjAA_keCPTwm2sz-QgTw6sz-Q09zJQ
`full_address`	Canonical address as supplied by our data sources. Type: `string`	31 Rue de la Belle Idée, 77720 Grandpuits-Bailly-Carrois
`success`	Returns true if the service ran successfully. Type: `boolean`	true

400 Invalid input or missing parameters.

Name	Description	Example
`error`	Description of the error Type: `string`	Missing required parameter 'key'

See API Error Reference for details.