API - Description - Address - ADR - GET

Support DQE
Support DQE
  • Updated

Use this endpoint in Funnel mode to search for street or address suggestions after selecting a locality from /CP/.

Related Address documentation:

ADR GET request

Endpoint

https://{SERVER_ADDRESS}/ADR/?IDLocalite={CITY_ID}&Adresse={ADDRESS}&Instance={VALUE}&Pays={COUNTRY_CODE}&Taille={LENGTH}&Version=1.1&Licence={LICENCE_CODE}&Langue={LANGUAGE}

Replace the values in braces with your own information.

Parameter Value Description Mandatory/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Address of the DQE server that will process the data. Mandatory
Licence {LICENCE_CODE} Licence code assigned to your account. Mandatory
IDLocalite {CITY_ID} Unique city ID returned by the /CP/ command. Mandatory
Adresse {ADDRESS} User input: part of the address being entered. Mandatory
Pays {COUNTRY_CODE} ISO 3-letter country code. Mandatory
Taille {LENGTH} Character limit for the address. Works only on Latin addresses. Optional. If not specified, default is 38. Recommended minimum value: 32.
Instance {VALUE} Allows you to pass a value during the call. Optional
Version 1.1 Allows the LieuDit field to be populated for small towns. Without this parameter, LieuDit is not populated for small towns and is instead included in the Localite field in brackets. Optional
Langue {LANGUAGE} For Japan only: JP Kanji, JK Katakana, EN English. Optional

Related to

Was this article helpful?

0 out of 0 found this helpful