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	Default	Description
`country`		ISO 3166 alpha-2 country code. Required string
`key`		Your unique Addressfinder license key. Required string
`secret`		Your unique secret key. You can also pass your secret key into the `Authorization` header of the request. Only required for server-to-server calls. Optional string
`q`		The partial address being searched. Max length 200 characters. Required string
`format`	`json`	The format of the response. Optional 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. Optional string
`max`	`10`	The maximum number of results to return. Between 1 and 15 (inclusive). Optional integer

Responses

200 A list of address completions

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

400 Invalid input or missing parameters.

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

See API Error Reference for details.