SearchOptions
Defines the parameters of a Search.
Important: This is a Public Preview API. It may be changed or removed at any time.
Parameters
The search query.
The maximum number of search results that will be returned.
A set of ISO 3166-1 alpha3 country codes. (e.g., FRA,ESP). This will limit the search to the specified countries.
The GeoPoint position where results should be biased.
The geographic filter for search, all search results returned are confined in the specified geography. Max number of geometries is 50. Three types of geometries can be passed as searchAreas: CircleGeometry, RectangleGeometry and PolygonGeometry When a single CircleGeometry is set the CircleGeometry center overrides geoBias.
The language in which search results should be returned. If not specified, language is set to the default official language of the location of the result.
A set of ResultType which should be used for the search. An empty set implies search can return results of any type.
Restricts the Points Of Interest in the response to those whose ID is listed.
A list of brand names (case sensitive) used to restrict the result.
A list of connector types used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types. See https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types for more details.
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.
A set of a FuelType used to restrict the result to Points Of Interest with those specific fuels.
Defines what kind of geopolitical view should be used.
The opening hours scope. If it's not provided, no data about opening hours will be returned.
A search session is a user session during which a user performs multiple search requests to find a specific address ot point of interest. This is needed for sending feedback to the online search.
Defines the parameters of a Search.
Important: This is a Public Preview API. It may be changed or removed at any time.
Parameters
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 ID is listed.
A list of brand names (case sensitive) used to restrict the result.
A set of a FuelType used to restrict the result to Points Of Interest with those specific fuels.
A list of connector types used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types. See https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types for more details.
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. Default value is SortBy.DetourTime.
The opening hours scope. If it's not provided, no data about opening hours will be returned.
A search session is a user session during which a user performs multiple search requests to find a specific address ot point of interest. This is needed for sending feedback to the online search.