This article describes the GET request for the Address COMPLV2 API. Use this endpoint to retrieve address complements, such as buildings, apartments or secondary address information, by passing parameters in the request URL after a user has selected an address from /SINGLEV2/.
Related Address documentation:
- Address API overview
- SINGLEV2 GET request
- COMPLV2 POST request
- COMPLV2 response
- Address Swagger documentation
COMPLV2 GET request
Endpoint
https://{SERVER_ADDRESS}/COMPLV2/?IDVoie={STREET_ID}&IDNum={NUM}&Taille={LENGTH}&Pays={COUNTRY_CODE}&Filter={FILTER}&Licence={LICENCE_CODE}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 |
| IDVoie | {STREET_ID} |
Unique street ID returned by the /SINGLEV2/ command. |
Mandatory |
| IDNum | {NUM} |
Number in the street. | 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. |
| Filter | {FILTER} |
For the United States: filters the complements returned in the response, for example apt. |
Optional |
Related to