This article describes the GET request for the RESTful Address funnelcompl API. Use this endpoint to retrieve address complements, such as buildings, apartments or secondary address information, by passing parameters in the request URL after selecting a street from /funneladdress/.
Related Address documentation:
- Address API overview
- Restful funneladdress GET request
- Restful funnelcompl POST request
- Restful funnelcompl response
- Restful Address Swagger documentation
Restful funnelcompl GET request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/funnelcompl/?StreetId={STREET_ID}&Country={COUNTRY_CODE}&StreetNumber={NUMBER}&Licence={LICENCE_CODE}&Langue={LANGUAGE}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 |
| VERSION | {VERSION} |
Version of the API, for example v1. |
Mandatory |
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| StreetId | {STREET_ID} |
Street ID selected previously. | Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| StreetNumber | {NUMBER} |
Street number. | Mandatory |
| Langue | {LANGUAGE} |
For Japan only: JP Kanji, JK Katakana, EN English. |
Optional |
Related to