Address Autocomplete API - Canada | Addressfinder Australia

Build
Send
Response
Errors

This page contains the technical API information. Please read our Javascript integration documentation if you are looking to learn more about the service.

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.

Build the GET request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Country

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). Alternatively, you can pass your secret key into the Authorization header of the request as such: `Authorization: your-secret`. FAQ: Learn more about authenticating direct API calls in request headers
q *		String	The partial address being searched. Maximum length is 200 characters.
format *		String	The required format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
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 15. The default is 10 results.

* Parameters marked with an asterisk are mandatory for this API call.

Request URL

https://api.addressfinder.io/api/:country_code:/address/v2/autocomplete/

      
        /* Click the button above to see a real API response here */
        {
          ...
        }

Response Specification

The API response will contain a hash with an element named completions, which is an array of hashes containing the following fields.

Field Name	Type	Description	Example
`id`	String	The unique address identifier.	_wIyMzMA_lYadSbnAP5TAyT-TB8Yjv8BT04A_wJONVcA_wI0Ujk
`full_address`	String	Canonical address as supplied by our sources	233 Vancouver St, London ON N5W 4R9

Errors

Below are the possible errors that can be returned by the API.