API - Description - Address - SINGLEV2 - GET

Support DQE
Support DQE
  • Updated

Use this endpoint to return address suggestions from a single address input field.

Related Address documentation:

SINGLEV2 GET request

Endpoint

https://{SERVER_ADDRESS}/SINGLEV2/?Adresse={INPUT}&Taille={LENGTH}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}&NbMax={NB}&Version=1&Instance={VALUE}&Langue={LANGUAGE}&Filter={FILTER}

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 or token generated by oauth2 Mandatory
Adresse {INPUT} User input. 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.
NbMax {NB} Limits the number of returned responses. Maximum value: 20. Optional. If not specified, default is 20.
Version 1 Allows the street type to be returned in the JSON response. Without this parameter, the street type is not sent in the dedicated key. Optional
Instance {VALUE} Allows you to pass a value during the call. Optional
Langue {LANGUAGE} For Japan only: JP Kanji, JK Katakana, EN English. Optional
Filter {FILTER} France only. Filters returned address types. Optional

Filter values for France

Value Description
1 All addresses.
2 No Cedex address only.
3 Cedex address only.

Related to

Was this article helpful?

0 out of 0 found this helpful