API Documentation

Articles

API Overview
Overview These documents describe the Autoaddress 3.0 API, including authentication, HTTP resources and recommended best practices. This content is intended for individuals with web development experience and knowledge of HTTP. The Autoaddress 3.0...
Create Token
The Create Token endpoint is used to exchange your API key for an access token that can be used to make API calls to the data endpoints.
Autocomplete
The Autocomplete endpoint is used to retrieve a list of suggested addresses from a search query.
Search
Overview The Search endpoint is used to retrieve a list of suggested addresses from a search query. We recommend that you read our API Overview  guide first. API Endpoint The Search API endpoint won't change and can be set as a cons...
Drilldown
Overview The Drilldown endpoint is used to retrieve further addresses that are contained in an area such as a building or street. Please read API Overview first. API Endpoint The Drilldown API endpoint won't change. It can be set as a co...
Lookup
The Lookup endpoint is used to retrieve a complete address using an AA3 ID returned from an API call to another endpoint such as Autocomplete or Drilldown.
GetData
Overview The Get Data endpoint is used to retrieve additional information about an address. The additional data is customer specific. Please read API Overview first. API Endpoint The Get Data API endpoint won't change. It can be set as a c...
Authentication
Overview All calls to the Autoaddress 3.0 API must be authenticated. This can be done by passing either an API key or token in a request. API Key Header An API key can be included in a request header using Basic authentication. The username is...