Address autocomplete Search API
Learn more about the Search API that integrates with Loqate to search for addresses.
The Address autocomplete feature enables you to quickly find and populate accurate address data by offering real-time suggestions as you type. For more information about the feature and how to enable it, see Address autocomplete .
This Search API retrieves real-time address suggestions based on your input. It returns candidate addresses based on user input text or container context. The response provides formatted suggestions suitable for address list that can be used to show a drop down in the application / webpage this feature is integrated into (including Reltio Hub UI).
Request
GET api/{tenantId}/address/search?Text=Reltio&Countries=USA,IN&Limit=10
GET api/{tenantId}/address/search?Text=Reltio&Countries=USA,IN&Container=in-lp%7CTLRp85YB1H6m_iwEIP0zParameters
| Parameters | Name | Required | Details |
|---|---|---|---|
| Headers | Authorization | Yes | Information about authentication access token in format "Bearer <accessToken>" (see details in Authentication API ). |
Content-Type | Yes | Should be "Content-Type: application/json". | |
| Query | tenantID | Yes | The tenant ID. |
Text | No | The free text query entered by the user. | |
Container | No | The building/apartment container to restrict the search. | |
Countries | No | Comma-separated ISO2 codes to restrict results. | |
Language | No | The Preferred language for search results using ISO 639-1 language codes | |
Limit | No | The maximum number of results to return. Default: 20. |
Request payload sample for search with text
curl --location 'https://tst-01.reltio.com/reltio/api/{{tenantId}}/address/search?Text=Reltio&Countries=USA,IN&Limit=10' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json'
Sample response
[
{
"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": ""
}
]Request payload sample for search with container
curl --location 'https://tst-01.reltio.com/reltio/api/{{tenantId}}/address/search?Container=in-lp|TLRp85YB1H6m_iwEIP0z' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json'Sample response
[
{
"Id": "US|LP|B|122687129|A_ENG",
"Type": "Address",
"Text": "123 Main St Apt A Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|184820847|B_ENG",
"Type": "Address",
"Text": "123 Main St Apt B Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|196924263|C_ENG",
"Type": "Address",
"Text": "123 Main St Apt C Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|218443841|D_ENG",
"Type": "Address",
"Text": "123 Main St Apt D Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|24456843|E_ENG",
"Type": "Address",
"Text": "123 Main St Apt E Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|11275749|F_ENG",
"Type": "Address",
"Text": "123 Main St Apt F Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|213067870|G_ENG",
"Type": "Address",
"Text": "123 Main St Apt G Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
},
{
"Id": "US|LP|B|30242350|H_ENG",
"Type": "Address",
"Text": "123 Main St Apt H Manchester CT 06042-3165",
"Highlight": "",
"Description": ""
}
]