The SINGLE endpoint converts geographic coordinates (latitude and longitude) into a street address.
Related Geocoding documentation:
- API - Description - Geocoding - LATLG
- Geocoding / Reverse Geo introduction
- Geocoding and Reverse Geocoding Swagger documentation
GET request
Endpoint
https://{SERVER_ADDRESS}/SINGLE/?Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}&Lat={LATITUDE}&Lon={LONGITUDE}&DistAdr={DISTANCE}Replace the values in braces with your own information:
| Parameter | Description | Mandatory/Optional |
|---|---|---|
| SERVER_ADDRESS | DQE server address used to process the request. | Mandatory |
| Licence | Your DQE licence code. | Mandatory |
| Pays | ISO 3-letter country code. | Mandatory |
| Lat | Latitude in decimal format. | Mandatory |
| Lon | Longitude in decimal format. | Mandatory |
| DistAdr | Search radius in kilometers. | Mandatory |
POST request
Endpoint
https://{SERVER_ADDRESS}/SINGLE/Add the following parameters in the request body using x-www-form-urlencoded.
| Parameter | Description | Mandatory/Optional |
|---|---|---|
| Licence | Your DQE licence code. | Mandatory |
| Pays | ISO 3-letter country code. | Mandatory |
| Lat | Latitude in decimal format. | Mandatory |
| Lon | Longitude in decimal format. | Mandatory |
| DistAdr | Search radius in kilometers. | Mandatory |
Response
Success response
The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains the following keys:
| Key | Description | France | International |
|---|---|---|---|
| IDLocalite | Unique code for each city. For France, this is the INSEE code. | STRING(10) | STRING(10) |
| Pays | ISO country code. | STRING(3) | STRING(3) |
| CodePostal | Postal code of the city. | INTEGER(5) | STRING(10) |
| Localite | City name. | STRING(38) | STRING(50) |
| IDVoie | Unique street identifier. | INTEGER(8) | STRING(10) |
| Voie | Street name. | STRING(38) | STRING(50) |
| Numero / Num | Street number. | INTEGER(4) | INTEGER(4) |
| NbNumero | Number of street numbers found. | INTEGER(4) | INTEGER(4) |
| Roudis | Roudis code. France only. | INTEGER(5) | Not available |
| Instance | Value passed in the request and returned in the response. | INTEGER(1) | INTEGER(1) |
| Saisie | Empty. | - | - |
| ListeNumero | Empty. | - | - |
Example:
{
"1": {
"IDLocalite": "92044",
"Saisie": "",
"Nbnumero": "1",
"Pays": "FRA",
"IDVoie": "1749869",
"Voie": "RUE VICTOR HUGO",
"Numero": "104",
"Instance": "",
"ListeNumero": "",
"Num": "104",
"CodePostal": "92300",
"NbNumero": "1",
"Localite": "LEVALLOIS PERRET",
"CodeVoie": "1749869"
}
}Related to