Route Search Options
Defines the parameters for the Search Along the Route query.
Important: This is a Public Preview API. It may be changed or removed at any time.
Supported connector types[https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types] for more details.
The route points define the skeleton of the search area.
The maximum detour duration (for a passenger car) limits the search area. The detour duration is the value added to the estimated time of arrival (to the final destination) after a point of interest is added to the route. Search results that add more than this value are filtered out. The maximum accepted value is 3600 seconds. If a value greater than the maximum is provided then the maximum value is used.
The search query.
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.
Brand names are used to restrict the result to POIs associated with those brands.
Connector types are used to restrict the results to electric vehicle stations that support those connector types.
A power rate, used to restrict the results to electric vehicle stations with at least one connector that has a power greater or equal to that minimum power.
A power rate, used to restrict the results to electric vehicle stations with at least one connector that has a power lesser or equal to that maximum power.
Defines what kind of geopolitical view should be used.
Defines how the results will be sorted.
Scope of the opening hours to be provided.
The ID of a user session during which a user performs multiple search requests to find a specific address or point of interest. This parameter is used for sending anonymous feedback to the online search for the search quality improvement.