This article describes the GET request for the RESTful Address COMPL 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 /single/.
Related Address documentation:
- Address API overview
- Restful SINGLE GET request
- Restful COMPL POST request
- Restful COMPL response
- Restful Address Swagger documentation
Restful COMPL GET request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/compl/?StreetId={STREETID}&StreetNumber={STREETNUMBER}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Length={LENGTH}&Search={SEARCH}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 |
| VERSION | {VERSION} |
Version of the API, for example v1. |
Mandatory |
| Licence | {LICENCE_CODE} |
Licence code assigned to your account or token generated by oauth2 | Mandatory |
| StreetId | {STREETID} |
Street ID of the selected address returned by /single/. |
Mandatory |
| StreetNumber | {STREETNUMBER} |
Street number of the selected address returned by /single/. This value can be empty. |
Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Length | {LENGTH} |
Character limit for the address. Works only on Latin addresses. | Optional. If not specified, default is 38. Recommended minimum value: 32. |
| Search | {SEARCH} |
For the United States: filters the complements returned in the response. | Optional |
Related to