AutocompleteRequest

A list of optional additional parameters that can be requested for each result.

The position in longitude and latitude that the results should be close to. Typically, place results returned are ranked higher the closer they are to this position. Stored in [lng, lat] and in the WSG84 format.

A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

Indicates if the results will be stored. Defaults to SingleUse, if left empty.

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry.

An optional limit for the number of results returned in a single call.

The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country.

The PostalCodeMode affects how postal code results are returned. If a postal code spans multiple localities and this value is empty, partial district or locality information may be returned under a single postal code result entry. If it's populated with the value EnumerateSpannedLocalities, all cities in that postal code are returned.

The free-form text query to match addresses against. This is usually a partially typed address from an end user in an address box or form.