Search addresses with the Address autocomplete Search API

Learn more about how to use the Address autocomplete Search API to retrieve real-time address suggestions.

Use the Address autocomplete search to retrieve candidate addresses for entered text or for a selected container. The response returns formatted address suggestions that an application displays in a suggestion list. For more information, see Address autocomplete.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request:

GET {TenantURL}/address/search

Replace {TenantURL} with your tenant base URL.

Request headers

Include the following headers in each request:


Name	Required	Description
`Authorization`	Yes	Bearer access token in the format `Bearer <accessToken>`. For authentication details, see Authentication API.
`Content-Type`	Yes	Set to `application/json`.

Query parameters

The following table describes the supported query parameters.


Name	Type	Required	Description
`Text`	String	No	Free-text input used to search for matching addresses.
`Container`	String	No	Container identifier used to restrict the search to a selected building or apartment container.
`Countries`	String	No	Comma-separated country codes used to restrict results.
`Language`	String	No	Preferred language for returned results.
`Limit`	Integer	No	Maximum number of suggestions to return.

Request body

This operation does not require a request body.

Example request

The following example searches for addresses by text:

GET {TenantURL}/address/search?Text=Reltio&Countries=US,IN&Limit=10
Authorization: Bearer <accessToken>
Content-Type: application/json

Example response

The following example shows address suggestions returned by the API:

[
  {
    "Id": "IN|LP|B|14161031|_ENG",
    "Type": "Address",
    "Text": "Reltio 17th Cross Road HSR Layout Bengaluru 560102",
    "Highlight": "0-6",
    "Description": ""
  },
  {
    "Id": "IN|LP|B|55231200|_ENG",
    "Type": "Address",
    "Text": "Reltio Hongasandra Bengaluru 560068",
    "Highlight": "0-6",
    "Description": ""
  }
]

Response fields

The following table describes the fields returned for each address suggestion in the response array.


Field	Type	Description
`Id`	String	Unique identifier of the returned address suggestion.
`Type`	String	Classification of the returned suggestion, for example `Address`.
`Text`	String	Formatted suggestion text that an application can display in an address list.
`Highlight`	String	Highlight information returned for the matching text.
`Description`	String	Additional context returned for the suggestion.

Unify and manage your data