suggest
The method suggest allows character-by-character autocomplete suggestions to be generated for user input in a client application. This capability facilitates the interactive search user experience by reducing the number of typed characters before a suggested match is obtained.
- Street Address
- Street Intersection
- Point of Interest
- Administrative Place Names
- Postal codes
Parameters
suggest uses required and optional parameters in a GET request to return suggested results from character by character input.
| Parameter | Details |
|---|---|
| f |
Required: The response format. The supported format is JSON. |
| text | Required: The input text to be used to find suggested candidates. |
| countryCode | Required: Defines the source country for the address. |
| searchExtent | Optional: Confine the search results to a specified area. Use as a starting point to expand as needed. |
| location | Optional: Confine the search results to a specified area. Use as a starting point to expand as needed. |
| maxSuggestions | Optional: Maximum number of suggestions to be returned. in a response. |
| matchOutofRange | Not supported. |
| locationType | Not supported. |