This article describes the GET request for the Address COMPL API. Use this endpoint to retrieve address complements, such as buildings, apartments or secondary address information, by passing parameters directly in the request URL after selecting a street from /ADR/.
Related Address documentation:
- Address API overview
- ADR GET request
- COMPL POST request
- COMPL response
- Address Swagger documentation
COMPL GET request
Endpoint
https://{SERVER_ADDRESS}/COMPL/?IDVoie={STREET_ID}&IDNum={NUM}&Taille={LENGTH}&Instance={VALUE}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}Replace the values in braces with your own information.
| Parameter | Expected value type | 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 |
| IDVoie | {STREET_ID} |
Unique street ID returned by the /ADR/ 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. |
| Instance | {VALUE} |
Allows you to pass a value during the call. | Optional |
Related to