This article describes the GET request for the RESTful Address funneladdress API. Use this endpoint to retrieve street or address suggestions by passing search parameters in the request URL after selecting a postal code or locality from /funnelpostcode/.
Related Address documentation:
- Address API overview
- Restful funnelpostcode GET request
- Restful funneladdress POST request
- Restful funneladdress response
- Restful Address Swagger documentation
Restful funneladdress GET request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/funneladdress/?CityId={CITY_ID}&Country={COUNTRY_CODE}&Street={INPUT}&Licence={LICENCE_CODE}&Limit={INTEGER}&Length={LENGTH}&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 |
| CityId | {CITY_ID} |
City ID selected previously. | Mandatory |
| Country | {COUNTRY_CODE} |
ISO 3-letter country code. | Mandatory |
| Street | {INPUT} |
Street input. | Mandatory |
| Limit | {INTEGER} |
Maximum number of suggestions returned by the call. | Optional |
| Length | {LENGTH} |
Maximum number of characters allowed. Minimum recommended value: 32. Works only on Latin addresses. |
Optional |
| Langue | {LANGUAGE} |
For Japan only: JP Kanji, JK Katakana, EN English. |
Optional |
Related to