Updated Articles

  1. 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. A User-Agent is required in the header to ensure the call is successful. API Key Header An API key c...
  2. 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 https://api.autoaddress.com/3.0/getdata Request To retrieve Ge...
  3. 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.
  4. 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 https://api.autoaddress.com/3.0/drilldown Request Please note: It...
  5. 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 https://api.autoaddress.com/3.0/search Request To retrieve Search res...
  6. Autocomplete

    The Autocomplete endpoint is used to retrieve a list of suggested addresses from a search query.
  7. Getting Started with the API

  8. Search for an Address

    When the end user is typing, each keystroke is passed to the autocomplete  endpoint. As the end user continues to type, keep calling autocomplete , passing the entered text and the same token from step 1. See the Autocomplete documentatio...
  9. 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.
  10. 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...