AlongRouteSearchOptions

The search query.

The route points.

The maximum detour time. The maximum value is 3600 seconds.

If this flag is set to true, the query will be interpreted as a partial input and the search will enter predictive mode.

The maximum number of search results that will be returned.

Restricts the Points Of Interest in the response to those whose category ID is listed.

A list of brand names used to restrict the result to POIs associated with those brands.

A list of connector types used to restrict the results to electric vehicle stations that support those connector types. See https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types for more details.

A double value representing a power rate in kilowatts, used to restrict the results to electric vehicle stations with at least one connector with that minimum power.

A double value representing a power rate in kilowatts, used the results to electric vehicle stations with at least one connector with that maximum power.

A set of FuelTypes, used to restrict the results to ones with specific fuels.

Defines what kind of geopolitical view should be used.

Parameter which turns on calculation of the distance between the start of the route and the starting point of the detour to a POI.

Defines how the results will be sorted.

Scope of the opening hours to be provided.

Defines the spreading of returned results along the route.

The set of MapCodeTypes which will be supported.

Used to indicate the mode in which the time zone object will be returned.

Uses the RequestedPoiRelationType to specify what kinds of related POIs to return. Points Of Interest.

Important: This is a Public Preview API. It may be changed or removed at any time.