# Tomtom

TomTom provides a suite of location-based services and APIs, including mapping, routing, traffic information, and geofencing, enabling developers to integrate advanced navigation and location functionalities into their applications.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 82
- **Triggers:** 0
- **Slug:** `TOMTOM`
- **Version:** 20260312_00

## Tools

### List Map Fonts

**Slug:** `TOMTOM_ASSETS_LIST_FONTS`

Tool to list available font asset versions for map rendering. Call after confirming the API key is valid.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assets Sprites

**Slug:** `TOMTOM_ASSETS_LIST_SPRITES`

Tool to list available sprites for a given asset version. Use after determining the assetVersion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | A valid TomTom API key. |
| `apiVersion` | string | No | API version of the service. Current value is '1'. |
| `assetVersion` | string | Yes | The chosen version of the asset in format MAJOR.MINOR.PATCH-BUILD (e.g., '0.6.1-0'). Wildcards are supported, e.g., '0.*'. |
| `assetCategories` | array | No | Optional filter for sprite categories. Possible values: 'map', 'trafficFlow', 'trafficIncidents'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List map styles

**Slug:** `TOMTOM_ASSETS_LIST_STYLES`

Tool to list available map styles. Use after selecting an asset version to retrieve style options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apiVersion` | string | Yes | The API version of the Orbis Maps service to call. This query parameter takes precedence over any header value. |
| `assetVersion` | string | Yes | The chosen version of the asset (e.g., '0.6.1-0' or wildcard '0.*'). Use wildcard patterns like '0.*' to get the latest matching version. See https://developer.tomtom.com/assets-api/documentation/tomtom-orbis-maps/product-information/assets-versioning |
| `assetCategories` | array | No | Optional list of asset categories to filter by. Valid categories include: 'map', 'trafficFlow', 'trafficIncidents', 'hillshade', 'poi', 'range', 'navigationAndRoute'. Provide multiple values to filter on multiple categories, e.g., ['map', 'trafficFlow']. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Long Distance EV Route

**Slug:** `TOMTOM_CALCULATE_LONG_DISTANCE_EV_ROUTE`

Tool to calculate long-distance electric vehicle routes with optimal charging stops. Use when planning EV trips that require charging along the route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `traffic` | boolean | No | Include real-time traffic data in route calculation. |
| `locations` | string | Yes | Colon-delimited list of route waypoint coordinates in format 'lat,lon:lat,lon'. Minimum 2 locations (origin and destination), maximum 152 locations. |
| `routeType` | string | No | Route calculation strategy (e.g., 'fastest', 'shortest', 'eco'). |
| `travelMode` | string | No | Mode of transport (e.g., 'car'). |
| `maxChargeInkWh` | number | No | Maximum battery capacity in kilowatt-hours (kWh). |
| `vehicleEngineType` | string | No | Must be 'electric' for EV routing. |
| `chargingParameters` | object | No | Charging parameters for the EV route calculation. |
| `currentChargeInkWh` | number | Yes | Current battery charge in kilowatt-hours (kWh). |
| `minChargeAtDestinationInkWh` | number | Yes | Minimum required charge at destination in kilowatt-hours (kWh). |
| `minChargeAtChargingStopsInkWh` | number | Yes | Minimum charge level at intermediate charging stops in kilowatt-hours (kWh). |
| `constantSpeedConsumptionInkWhPerHundredkm` | string | Yes | Comma-separated pairs of speed (km/h) and consumption (kWh per 100km) in format 'speed1,consumption1:speed2,consumption2'. Used to model energy consumption at different speeds. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Matrix Routing Sync

**Slug:** `TOMTOM_CALCULATE_MATRIX_ROUTING_SYNC`

Tool to calculate route matrix synchronously for multiple origins and destinations (up to 200 cells). Use when you need travel times and distances between multiple location pairs with support for traffic, vehicle parameters, and routing options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `options` | object | No | Optional routing and vehicle configuration parameters. |
| `origins` | array | Yes | Non-empty list of origin locations. Matrix size (origins × destinations) must not exceed 200 cells for synchronous endpoint. |
| `destinations` | array | Yes | Non-empty list of destination locations. Matrix size (origins × destinations) must not exceed 200 cells for synchronous endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Reachable Range

**Slug:** `TOMTOM_CALCULATE_REACHABLE_RANGE`

Tool to calculate the reachable range from a starting point given time, fuel, or energy constraints. Use when you need to determine how far a vehicle can travel from an origin within specified budgets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `avoid` | string | No | Specifies road segment types to avoid (comma-separated). Options: 'tollRoads', 'motorways', 'ferries', 'unpavedRoads', 'carpools'. |
| `origin` | string | Yes | Point from which the range calculation should start, formatted as 'latitude,longitude'. |
| `report` | string | No | Specifies which data should be reported for diagnosis purposes. Use 'effectiveSettings' to include effective settings in the response. |
| `traffic` | boolean | No | Determines whether current traffic is used in route calculations. Historic road speeds are always used. |
| `callback` | string | No | Specifies the jsonp callback method (only used when content_type is 'jsonp'). |
| `arrive_at` | string | No | The date and time of arrival at the destination point. Must be specified as ISO 8601 dateTime. |
| `depart_at` | string | No | The date and time of departure from the origin point. Use 'now' for current time or specify as ISO 8601 dateTime. |
| `hilliness` | string ("low" | "normal" | "high") | No | Degree of hilliness for thrilling routes. |
| `route_type` | string ("fastest" | "shortest" | "eco" | "thrilling") | No | Route calculation strategy. |
| `travel_mode` | string ("car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian") | No | Mode of travel. |
| `windingness` | string ("low" | "normal" | "high") | No | Amount of windingness for thrilling routes. |
| `content_type` | string ("xml" | "json" | "jsonp") | No | The content type of the response structure. Use 'json' for standard JSON responses. |
| `request_body` | object | No | Optional request body data for the reachable range calculation. |
| `vehicle_width` | number | No | Width of the vehicle in meters. |
| `vehicle_height` | number | No | Height of the vehicle in meters. |
| `vehicle_length` | number | No | Length of the vehicle in meters. |
| `vehicle_weight` | integer | No | Weight of the vehicle in kilograms. |
| `uphill_efficiency` | number | No | Efficiency of converting chemical energy to potential energy when gaining elevation (0-1). |
| `vehicle_load_type` | string | No | Indicates hazardous materials the vehicle is carrying. May restrict certain roads. Examples: 'USHazmatClass1', 'otherHazmatExplosive'. |
| `vehicle_max_speed` | integer | No | Maximum speed of the vehicle in km/hour. |
| `time_budget_in_sec` | number | No | Time budget in seconds. Determines the maximum vehicle range using the specified driving time. |
| `vehicle_commercial` | boolean | No | Indicates that the vehicle is used for commercial purposes. May restrict certain roads. |
| `downhill_efficiency` | number | No | Efficiency of converting potential energy to saved fuel when losing elevation (0-1). |
| `vehicle_axle_weight` | integer | No | Weight per axle of the vehicle in kg. |
| `vehicle_engine_type` | string ("combustion" | "electric") | No | Vehicle engine type. |
| `energy_budget_in_kwh` | number | No | Electric energy budget in kilowatt hours (kWh). Determines the maximum vehicle range using the specified Electric Consumption Model. |
| `fuel_budget_in_liters` | number | No | Fuel budget in liters. Determines the maximum vehicle range using the specified Combustion Consumption Model. |
| `current_fuel_in_liters` | number | No | Current supply of fuel in liters. |
| `acceleration_efficiency` | number | No | Efficiency of converting chemical energy to kinetic energy when accelerating (0-1). |
| `deceleration_efficiency` | number | No | Efficiency of converting kinetic energy to saved fuel when decelerating (0-1). |
| `auxiliary_power_in_liters_per_hour` | number | No | Fuel consumed for sustaining auxiliary systems, in liters per hour. |
| `fuel_energy_density_in_mjoules_per_liter` | number | No | Chemical energy stored in one liter of fuel in megajoules (MJ). |
| `constant_speed_consumption_in_kwh_per_hundredkm` | string | No | Speed-dependent electric consumption as unordered list of speed/consumption-rate pairs (e.g., '50,8.2:130,21.3'). |
| `constant_speed_consumption_in_liters_per_hundredkm` | string | No | Speed-dependent consumption as unordered list of speed/consumption-rate pairs (e.g., '50,6.3:130,11.5'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Route

**Slug:** `TOMTOM_CALCULATE_ROUTE`

Tool to calculate driving routes. Use when you need directions with optional waypoints and traffic consideration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | Destination coordinates as 'lat,lon'. |
| `avoid` | string | No | Features to avoid (comma-separated), e.g., 'tollRoads,highways'. |
| `start` | string | Yes | Origin coordinates as 'lat,lon'. |
| `report` | string | No | Additional report fields, e.g., 'effectiveSettings,travelTimes'. |
| `traffic` | boolean | No | Whether to consider live traffic data. |
| `language` | string | No | Language for instructions and results. |
| `arrive_at` | string | No | Arrival time in ISO 8601 format. |
| `depart_at` | string | No | Departure time in ISO 8601 format. |
| `waypoints` | string | No | Intermediate waypoints as 'lat,lon:lat,lon'. |
| `route_type` | string ("fastest" | "shortest" | "eco" | "thrilling") | No | Route calculation strategy. |
| `travel_mode` | string ("car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian") | No | Mode of transport. |
| `section_type` | string | No | Comma-separated list of section types to include, e.g., 'traffic,toll'. |
| `instructions_type` | string ("coded" | "text" | "tagged") | No | Format of guidance instructions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Calculate Route with Body

**Slug:** `TOMTOM_CALCULATE_ROUTE_WITH_BODY`

Tool to calculate routes with advanced options via POST request. Use when you need to specify supporting points, avoid specific geographic areas, or configure vignette preferences.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `avoid` | string | No | Comma-separated road segment types to avoid (e.g., 'tollRoads,motorways,ferries,unpavedRoads,carpools,alreadyUsedRoads'). |
| `report` | string | No | Data to report for diagnostics (e.g., 'effectiveSettings'). |
| `traffic` | boolean | No | Whether to use current traffic in route calculation. Historic road speeds are always used. |
| `arriveAt` | string | No | Arrival date and time at destination in ISO 8601 dateTime format. |
| `callback` | string | No | JSONP callback method name (only for jsonp contentType). |
| `departAt` | string | No | Departure date and time from origin. Use 'now' or ISO 8601 dateTime format. |
| `language` | string | No | Language of guidance messages (e.g., 'en-GB', 'de-DE'). |
| `hilliness` | string ("low" | "normal" | "high") | No | Degree of hilliness for thrilling routes (only applies when routeType=thrilling). |
| `locations` | string | Yes | Colon-delimited list of coordinates through which the route must pass, in format 'lat1,lon1:lat2,lon2:lat3,lon3'. Minimum 2 locations required. |
| `routeType` | string ("fastest" | "shortest" | "eco" | "thrilling") | No | Type of route requested based on optimization criteria. |
| `travelMode` | string ("car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian") | No | Mode of travel for the requested route. |
| `contentType` | string ("xml" | "json" | "jsonp") | No | The content type of the response structure. If jsonp, use callback parameter. |
| `requestBody` | object | No | Request body containing advanced routing options like supporting points, avoid areas, and vignette preferences. |
| `sectionType` | string | No | Comma-separated section types to report (e.g., 'carTrain,ferry,tunnel,motorway,pedestrian,tollRoad,tollVignette,country,travelMode,traffic'). |
| `windingness` | string ("low" | "normal" | "high") | No | Amount of winding for thrilling routes (only applies when routeType=thrilling). |
| `vehicleWidth` | number | No | Width of the vehicle in meters. |
| `vehicleHeight` | number | No | Height of the vehicle in meters. |
| `vehicleLength` | number | No | Length of the vehicle in meters. |
| `vehicleWeight` | integer | No | Weight of the vehicle in kilograms. |
| `versionNumber` | integer | No | Service version number. Current value is 1. |
| `vehicleHeading` | integer | No | Directional heading of the vehicle in degrees (0-359), measured clockwise from north. |
| `alternativeType` | string ("anyRoute" | "betterRoute") | No | Whether alternative routes should be better than the reference route with respect to planning criteria. |
| `maxAlternatives` | integer | No | Number of alternative routes to calculate (0-5). |
| `vehicleLoadType` | string | No | Comma-separated hazardous material types being carried (e.g., 'USHazmatClass1,USHazmatClass2' for US or 'otherHazmatExplosive' for other countries). Only for travelMode=truck. |
| `vehicleMaxSpeed` | integer | No | Maximum speed of the vehicle in km/h. |
| `computeBestOrder` | boolean | No | Re-order route waypoints to minimize total route length. |
| `instructionsType` | string ("coded" | "text" | "tagged") | No | Format of guidance instructions to return, if available. |
| `minDeviationTime` | integer | No | Minimum time in seconds that alternative routes will follow the reference route from origin. |
| `uphillEfficiency` | number | No | Efficiency of converting fuel to potential energy when gaining elevation (0-1). |
| `vehicleAxleWeight` | integer | No | Weight per axle of the vehicle in kilograms. |
| `vehicleCommercial` | boolean | No | Whether the vehicle is used for commercial purposes (affects allowed roads). |
| `vehicleEngineType` | string ("combustion" | "electric") | No | Engine type of the vehicle. |
| `downhillEfficiency` | number | No | Efficiency of converting potential energy to saved fuel when losing elevation (0-1). |
| `currentFuelInLiters` | number | No | Current fuel supply in liters. |
| `routeRepresentation` | string ("polyline" | "none") | No | Representation format for the route geometry. |
| `computeTravelTimeFor` | string ("none" | "all") | No | Whether to return additional travel times using different traffic types. |
| `minDeviationDistance` | integer | No | Minimum distance in meters that alternative routes will follow the reference route from origin. |
| `accelerationEfficiency` | number | No | Efficiency of converting fuel to kinetic energy during acceleration (0-1). |
| `decelerationEfficiency` | number | No | Efficiency of converting kinetic energy to saved fuel during deceleration (0-1). |
| `auxiliaryPowerInLitersPerHour` | number | No | Fuel consumed for auxiliary vehicle systems in liters per hour. |
| `fuelEnergyDensityInMJoulesPerLiter` | number | No | Chemical energy stored in one liter of fuel in megajoules (MJ). |
| `constantSpeedConsumptionInkWhPerHundredkm` | string | No | Speed-dependent electric consumption as comma-separated speed:consumption pairs in kWh per 100km (e.g., '50,8.2:100,13.5'). |
| `constantSpeedConsumptionInLitersPerHundredkm` | string | No | Speed-dependent fuel consumption as comma-separated speed:consumption pairs (e.g., '50,6.3:100,8.2'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Category Search

**Slug:** `TOMTOM_CATEGORY_SEARCH`

Tool to search for Points of Interest by category. Use when you need to find POIs within a specific category around a location or area.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ext` | string | No | Comma-separated extra POI fields to include (e.g., 'openingHours,contact') |
| `lat` | number | No | Latitude of the search center (decimal degrees) |
| `lon` | number | No | Longitude of the search center (decimal degrees) |
| `ofs` | integer | No | Offset for pagination of results |
| `bbox` | string | No | Bounding box to restrict results in 'minLat,minLon,maxLat,maxLon' format |
| `view` | string | No | Geopolitical view for the search (e.g., 'Unified') |
| `limit` | integer | No | Maximum number of results to return (default: 10, max: 100) |
| `idxSet` | string | No | Comma-separated indexes/data sources to use (e.g., 'POI,ADR') |
| `radius` | integer | No | Search radius in meters (requires lat & lon) |
| `category` | string | Yes | Category ID(s) or keywords to search for (path parameter) |
| `language` | string | No | IETF language tag for response localization |
| `countrySet` | string | No | Comma-separated list of ISO country codes to limit search |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Notifications Contact Group

**Slug:** `TOMTOM_CREATE_NOTIFICATIONS_GROUPS`

Tool to create a contact group for TomTom notifications. Use when you need to set up a group of webhooks or emails to receive notification alerts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the contact group (optional, max 255 characters) |
| `emails` | array | No | List of email addresses to receive notifications (max 20 emails) |
| `webhookUrls` | array | No | List of webhook URLs to receive notifications (max 20 URLs) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Routing Batch

**Slug:** `TOMTOM_CREATE_ROUTING_BATCH`

Tool to submit asynchronous batch routing requests to TomTom API. Use when you need to calculate multiple routes efficiently in a single batch operation. The API returns a batch ID that can be used to retrieve results once processing is complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchItems` | array | Yes | Array of routing queries to be processed in batch. Each item contains a 'query' field with the route calculation endpoint path. |
| `redirectMode` | string ("auto" | "manual") | No | Controls HTTP response code: 'auto' returns HTTP 303 with Location header for immediate redirect, 'manual' returns HTTP 202 for manual polling. Default is 'auto'. |
| `waitTimeSeconds` | integer | No | Maximum wait time in seconds for batch processing to complete before returning response. Valid range: 5-60 or 120 seconds. Default is 120. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Routing Batch Sync

**Slug:** `TOMTOM_CREATE_ROUTING_BATCH_SYNC`

Tool to execute synchronous batch routing requests for multiple routes or reachable ranges. Use when you need to calculate multiple routes or reachable ranges in a single API call (max 100 items).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchItems` | array | Yes | Array of batch request items. Maximum 100 items allowed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Routing Matrix Async

**Slug:** `TOMTOM_CREATE_ROUTING_MATRIX_ASYNC`

Tool to submit asynchronous matrix routing calculation between multiple origins and destinations. Use when you need to calculate travel times and distances for large matrices (returns immediately with a job ID for later retrieval).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `options` | object | No | Optional routing configuration including time, route type, travel mode, and traffic settings |
| `origins` | array | Yes | Non-empty list of origin points with latitude/longitude coordinates |
| `destinations` | array | Yes | Non-empty list of destination points with latitude/longitude coordinates |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Waypoint Optimization

**Slug:** `TOMTOM_CREATE_ROUTING_WAYPOINTOPTIMIZATION`

Tool to optimize the sequence of waypoints to find the fastest route. Use when you need to find the optimal order to visit multiple locations (2-12 waypoints) with optional time windows and service time constraints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `options` | object | No | Optional routing configuration and constraints |
| `waypoints` | array | Yes | List of waypoints to optimize. Must contain 2-12 waypoints including origin and destination |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Geometry Filter

**Slug:** `TOMTOM_CREATE_SEARCH_GEOMETRYFILTER`

Tool to filter POIs by geometric boundaries (circles or polygons). Use when you need to check which POIs from a list fall within specific geographic areas. Supports up to 50 POIs per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ext` | string ("json" | "jsonp" | "js" | "xml") | No | Expected response format. Default is json. |
| `poiList` | array | Yes | List of POIs to filter by the specified geometries. Maximum 50 POIs per request. |
| `geometryList` | array | Yes | List of geometry filters (circles or polygons) to apply. Each geometry defines a spatial boundary. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Snap to Roads

**Slug:** `TOMTOM_CREATE_SNAP_TO_ROADS`

Tool to snap GPS track points to the road network, correcting for GPS inaccuracies. Use when you need to match raw GPS coordinates to actual roads for route reconstruction or map matching.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `points` | array | Yes | Array of GPS points to snap to roads. Minimum 2 points, maximum 5000 points. |
| `versionNumber` | string | No | API version number. Current value is '1'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Snap to Roads Batch

**Slug:** `TOMTOM_CREATE_SNAP_TO_ROADS_BATCH`

Tool to submit asynchronous batch snap to roads requests to TomTom API. Use when you need to snap multiple GPS traces to the road network efficiently. The API returns a batch ID that can be used to retrieve results once processing is complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchItems` | array | Yes | Array of batch items. Each item contains a query string and GPS points to snap to the road network. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Notifications History

**Slug:** `TOMTOM_DELETE_NOTIFICATIONS_HISTORY`

Tool to clear the entire notifications history for the account. Use when you need to delete all historical notification records. This is an asynchronous operation that returns a PROCESSING status immediately.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Batch Search Results

**Slug:** `TOMTOM_DOWNLOAD_BATCH_SEARCH_ASYNC`

Tool to download results of an asynchronous batch search job. Use when you have a batch ID from a previous batch submission and need to retrieve the search results. Returns HTTP 202 if still processing (with Location header for retry), or HTTP 200 with complete results when finished.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchId` | string | Yes | Unique batch identifier from the submission response |
| `waitTimeSeconds` | integer | No | Maximum wait time in seconds before returning 202 if still processing. Allowed values: 5-60 or 120 (default). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Matrix Routing Async Result

**Slug:** `TOMTOM_DOWNLOAD_MATRIX_ROUTING_ASYNC_RESULT`

Tool to download results of asynchronous matrix routing job. Use when you need to retrieve completed matrix routing results using the job ID from a previous async matrix submission.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | Unique job identifier from the async matrix routing submission response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Snap to Roads Async Result

**Slug:** `TOMTOM_DOWNLOAD_SNAP_TO_ROADS_ASYNC_RESULT`

Tool to download results of asynchronous snap to roads batch job. Use when you need to retrieve completed snap to roads results using the job ID from a previous async batch submission. Returns batch items with projected GPS points snapped to actual road geometry and detailed road information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | Unique job identifier from the asynchronous Snap to Roads batch submission response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### EV Charging Stations Availability

**Slug:** `TOMTOM_EV_CHARGING_STATIONS_AVAILABLE`

Tool to retrieve EV charging station availability info. Use when you have the chargingAvailability ID (from POI search dataSources) to get live availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `maxPowerKW` | number | No | Maximum charging power in kilowatts to filter results. |
| `minPowerKW` | number | No | Minimum charging power in kilowatts to filter results. |
| `connectorSet` | string | No | Comma-separated list of connector types to filter results (e.g., 'IEC62196Type2CableAttached,IEC62196Type2Outlet'). |
| `chargingAvailability` | string | Yes | The chargingAvailability ID (UUID format) retrieved from the dataSources section of a POI search result. Example: '00112233-4455-6677-8899-aabbccddeeff' |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Flow Segment Data

**Slug:** `TOMTOM_FLOW_SEGMENT_DATA`

Tool to retrieve traffic flow data for a specific road segment. Use when you need current and free flow speeds for given coordinates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unit` | string ("KMPH" | "MPH") | No | Unit for speed values. |
| `zoom` | integer | Yes | Zoom level for the flow segment data (0-22). |
| `point` | string | Yes | Center point of the segment in 'lat,lon' format. |
| `style` | string | Yes | Display style of the flow data. |
| `format` | string ("json" | "xml") | Yes | Response format of the data. |
| `openLr` | boolean | No | Whether to include OpenLR descriptors in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fuzzy Search

**Slug:** `TOMTOM_FUZZY_SEARCH`

Tool to perform a fuzzy search for addresses and points of interest. Use when you need flexible matching on free-form location queries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for contextual biasing |
| `lon` | number | No | Longitude for contextual biasing |
| `ofs` | integer | No | Starting offset for returned results |
| `view` | string ("Unified" | "AR") | No | Geopolitical view for geography rendering |
| `limit` | integer | No | Maximum number of results to return |
| `query` | string | Yes | Free-form search text for address or POI |
| `idxSet` | string | No | Comma-separated index types (e.g., 'PAD,Geo,Addr') |
| `radius` | integer | No | Bias radius in meters around lat/lon |
| `geobias` | string ("on" | "off") | No | Enable or disable geobias (default: 'on') |
| `brandSet` | string | No | Comma-separated brand names to restrict results |
| `language` | string | No | Response language (e.g., 'en-US') |
| `countrySet` | string | No | Comma-separated country codes to restrict results (e.g., 'US,CA') |
| `minPowerKW` | integer | No | Minimum power (kW) for EV charging stations |
| `boundingBox` | string | No | Limit to bounding box: 'minLon,minLat,maxLon,maxLat' |
| `categorySet` | string | No | Comma-separated category IDs (e.g., '7315,9362') |
| `relatedPois` | string ("off" | "child" | "all") | No | Return related POIs: 'off', 'child', or 'all' |
| `categoryType` | string ("POI" | "Geography") | No | Restrict to POI or geography categories |
| `connectorSet` | string | No | Comma-separated EV connector types (e.g., 'IEC_62196_T2') |
| `openingHours` | string ("nextSevenDays" | "nextLocalDay") | No | Filter by opening hours |
| `entityTypeSet` | string | No | Comma-separated entity types to restrict |
| `politicalView` | string | No | Political view parameter for geography rendering |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Geocode Query

**Slug:** `TOMTOM_GEOCODE_QUERY`

Tool to convert a free-form address query into geographic coordinates. Use when you need to geocode an address string without structured fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ext` | string ("json" | "jsonp" | "js" | "xml") | No | Expected response format. |
| `lat` | number | No | Latitude where results should be biased. Supplying a lat/lon without a radius will return search results biased to that point. |
| `lon` | number | No | Longitude where results should be biased. Supplying a lat/lon without a radius will return search results biased to that point. |
| `ofs` | integer | No | Starting offset of the returned results within the full result set. |
| `view` | string ("Unified" | "IN" | "PK" | "IL" | "MA") | No | Geopolitical view for geography rendering |
| `limit` | integer | No | Maximum number of search results that will be returned. |
| `query` | string | Yes | Address query string to geocode. Must be properly URL encoded. |
| `radius` | integer | No | If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters. |
| `topLeft` | string | No | Top left position of the bounding box. This is specified as a comma separated string composed of lat,lon. |
| `btmRight` | string | No | Bottom right position of the bounding box. This is specified as a comma separated string composed of lat,lon. |
| `language` | string | No | Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. |
| `typeahead` | boolean | No | If set, the query will be interpreted as a partial input and the search will enter predictive mode. |
| `countrySet` | string | No | Comma separated string of country codes to limit the search to specified countries. |
| `storeResult` | boolean | No | If set, the query will be interpreted as a stored geocode and will be billed according to terms of use. |
| `extendedPostalCodesFor` | string | No | Indexes for which extended postal codes should be included in the results. Available indexes: Addr (Address ranges), Geo (Geographies), PAD (Point Addresses), POI (Points of Interest), Str (Streets), XStr (Cross Streets). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Autocomplete Suggestions

**Slug:** `TOMTOM_GET_AUTOCOMPLETE`

Tool to get search suggestions as user types a query. Use when you need autocomplete suggestions for partial search input based on recognized entities like brands, categories, or locations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for biasing results (must be paired with lon) |
| `lon` | number | No | Longitude for biasing results (must be paired with lat) |
| `limit` | integer | No | Maximum number of autocomplete results (default: 5, max: 10) |
| `query` | string | Yes | Search term to get autocomplete suggestions for, must be URL encoded |
| `radius` | integer | No | Search area radius in meters (max: 5,000,000) |
| `language` | string | Yes | IETF language tag for results (e.g., en-US, fr-FR) |
| `resultSet` | string | No | Filter by segment type: 'category', 'brand', or both |
| `countrySet` | string | No | Comma-separated ISO 3166-1 alpha-2 country codes to restrict results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Tile Copyrights

**Slug:** `TOMTOM_GET_COPYRIGHTS`

Tool to retrieve copyright information for TomTom map tiles. Use when you need to display attribution or copyright notices for map content.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Geometry Search

**Slug:** `TOMTOM_GET_GEOMETRY_SEARCH`

Tool to search for POIs and locations within specified geometric areas (circles or polygons). Use when you need to find places within custom-defined boundaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of search results to return (default: 10) |
| `query` | string | Yes | Search query string (e.g., 'restaurant', 'pizza'). Will be URL-encoded automatically. |
| `idxSet` | string | No | Comma-separated list of indexes to use for search: Addr, Geo, PAD, POI, Str, Xstr |
| `language` | string | No | IETF language tag for response localization (e.g., 'en-US') |
| `geometryList` | string | No | JSON string containing list of geometries to filter by. Supports CIRCLE (with radius in meters and position as 'lat,lon') and POLYGON (with vertices as array of 'lat,lon' strings). Example: '[{"type":"CIRCLE","position":"37.7749,-122.4194","radius":5000}]' |
| `extendedPostalCodesFor` | string | No | Comma-separated indexes for which extended postal codes should be included: Addr, Geo, PAD, POI, Str, XStr |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Hillshade Tile

**Slug:** `TOMTOM_GET_HILLSHADE_TILE`

Tool to retrieve hillshade terrain map tiles for specified coordinates and zoom. Use when you need terrain elevation shading overlays for map visualization.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | Tile X coordinate (0 to 2^zoom - 1). |
| `y` | integer | Yes | Tile Y coordinate (0 to 2^zoom - 1). |
| `z` | integer | Yes | Zoom level between 0 (world) and 13 (maximum detail for hillshade tiles). |
| `style` | string | No | Tile style type. Currently only 'main' is supported for hillshade tiles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Incident Viewport

**Slug:** `TOMTOM_GET_INCIDENT_VIEWPORT`

Tool to retrieve incident viewport information including Traffic Model ID. Use when you need the current traffic model ID for a map viewport to make subsequent traffic API calls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `copyright` | boolean | Yes | Determines what copyright information to return. True returns full copyright text, false returns index only. |
| `bounding_box` | string | Yes | Bounding box of the map viewport in EPSG:900913 projection. Format: minX,minY,maxX,maxY |
| `content_type` | string ("json" | "xml" | "jsonp") | Yes | The content type of the response structure. |
| `overview_box` | string | Yes | Bounding box of the overview map in EPSG:900913 projection. Format: minX,minY,maxX,maxY |
| `bounding_zoom` | integer | Yes | The zoom level of the map viewport (0-22). |
| `overview_zoom` | integer | Yes | Zoom level of the overview map (0-22). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Copyrights Bounding Box

**Slug:** `TOMTOM_GET_MAP_COPYRIGHTS_BOUNDING_BOX`

Tool to retrieve copyright information for a geographic bounding box. Use when you need attribution for a specific map area defined by coordinates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "jsonp" | "xml") | No | Format of the response (json, jsonp, or xml). |
| `max_lat` | number | Yes | Maximum latitude coordinate of bounding box. |
| `max_lon` | number | Yes | Maximum longitude coordinate of bounding box. |
| `min_lat` | number | Yes | Minimum latitude coordinate of bounding box. |
| `min_lon` | number | Yes | Minimum longitude coordinate of bounding box. |
| `callback` | string | No | Specifies the jsonp callback method. Only used when format is jsonp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Copyrights Caption

**Slug:** `TOMTOM_GET_MAP_COPYRIGHTS_CAPTION`

Tool to retrieve the copyright caption text for TomTom maps. Use when you need to display attribution or copyright notices on map displays.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "jsonp" | "xml") | No | Format of the response (json, jsonp, or xml). |
| `callback` | string | No | Specifies the jsonp callback method. Only used when format is jsonp. |
| `versionNumber` | integer | No | Version of the service to call. The current version is 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Copyrights (Global)

**Slug:** `TOMTOM_GET_MAP_COPYRIGHTS_FORMAT`

Tool to retrieve copyright information for the whole world in the Maps API Raster Tile Service. Use when you need global copyright data for map display attribution.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `format` | string ("json" | "jsonp" | "xml") | No | Format of the response (json, jsonp, or xml). |
| `callback` | string | No | Specifies the jsonp callback method. Only used when format is jsonp. |
| `version_number` | integer ("1") | No | Version of the service to call. The current version is 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orbis Map Tile

**Slug:** `TOMTOM_GET_MAPS_ORBIS_MAP_TILE`

Tool to retrieve Orbis map tiles at specified zoom level and coordinates. Use when you need high-quality map tiles for custom map rendering. Supports both raster (PNG) and vector (PBF) tile formats.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | Tile X coordinate. Must be between 0 and 2^z - 1. |
| `y` | integer | Yes | Tile Y coordinate. Must be between 0 and 2^z - 1. |
| `z` | integer | Yes | Zoom level (0-22). At zoom 0, the entire world fits on a single tile. Higher values provide more detail. |
| `view` | string | No | Geopolitical view. Controls how disputed borders and areas are displayed. Examples: 'Unified', 'IN' (India), 'US' (United States), 'AR' (Argentina). |
| `style` | string ("street-light" | "street-dark") | No | Map style for raster tiles. |
| `format` | string ("png" | "pbf") | No | Format of the tile. Use 'png' for raster tiles or 'pbf' for vector tiles. |
| `language` | string | No | IETF language code for map labels. Controls the language of text on the map. |
| `tileSize` | integer ("256" | "512") | No | Tile size in pixels. |
| `apiVersion` | integer | No | API version to use. Defaults to 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orbis Traffic Incident Tile

**Slug:** `TOMTOM_GET_MAPS_ORBIS_TRAFFIC_TILE`

Tool to retrieve Orbis Traffic Incident Tiles containing traffic incident data in Protocol Buffer format. Use when you need detailed traffic incident information for a specific tile coordinate at a given zoom level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | X coordinate on zoom grid (0 to 2^zoom-1). Represents the horizontal tile position. |
| `y` | integer | Yes | Y coordinate on zoom grid (0 to 2^zoom-1). Represents the vertical tile position. |
| `z` | integer | Yes | Tile zoom level (0-22). Higher values provide more detail. |
| `tags` | array | No | Filters response tags. Available tags: icon_category, left_hand_traffic, magnitude_of_delay, road_category, road_subcategory. |
| `language` | string | No | Output language for incident descriptions. Use standard language codes. |
| `apiVersion` | string | No | API version to use for the request. |
| `categoryFilter` | string | No | Filters incident types by category. Comma-separated numeric values 0-14 (0=Unknown, 1=Accident, 2=Fog, 3=DangerousConditions, 4=Rain, 5=Ice, 6=Jam, 7=LaneClosed, 8=RoadClosed, 9=RoadWorks, 10=Wind, 11=Flooding, 14=BrokenDownVehicle). Omit for all incident types. |
| `traffic_model_id` | string | No | Traffic Model ID reference. Use '-1' to return the most recent traffic data. |
| `roadCategoryFilter` | string | No | Narrows the road types included in the response. Comma-separated values: motorway, motorway_link, trunk, trunk_link, primary, primary_link, secondary, secondary_link, tertiary, tertiary_link, street, service, track. Omit for all road types. |
| `timeValidityFilter` | string | No | Filters incidents by occurrence timing. Use 'present' for current incidents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Style Metadata

**Slug:** `TOMTOM_GET_MAP_STYLE_METADATA`

Tool to retrieve map style metadata. Use to get a list of available map style resources. Returns available style files like flow styles and incident styles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resourceVariant` | string | No | Resource variant name. Only applicable when resourceVersion is provided. Filters metadata by the specified variant. |
| `resourceVersion` | string | No | Specific version or partial version with wildcard (e.g., '20.*', '20.0.2-*'). When provided, retrieves metadata for the specified version only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get map styles metadata

**Slug:** `TOMTOM_GET_MAP_STYLES`

Tool to retrieve map style metadata as a Mapbox Style Specification JSON. Use to get a merged style definition combining map, traffic, and POI components for vector map rendering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `map` | string | No | Map style selection to compose into the merged style. Common values include: 'basic_main', 'basic_night', 'hybrid_main', 'labels_main'. Lite variants are also available (e.g., 'basic_main-lite'). |
| `poi` | string | No | Point-of-interest style to include in the merged style. Common values: 'poi_main', 'poi_dynamic'. |
| `version` | string | Yes | Version of the requested style resource (e.g., '20.3.4-6'). Supports wildcards like '20.*' or '20.3.2-*' to retrieve the latest matching version. Must be version 20.3.2-3 or newer. |
| `traffic_flow` | string | No | Traffic flow display style to include in the merged style. Common values: 'flow_absolute', 'flow_relative0'. |
| `traffic_incidents` | string | No | Traffic incident visualization style to include in the merged style. Common values: 'incidents_day', 'incidents_night', 'incidents_s0'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Group

**Slug:** `TOMTOM_GET_NOTIFICATIONS_GROUPS_GROUPID`

Tool to retrieve details of a specific contact group by its UUID. Use when you need to get the name, webhook URLs, and email addresses associated with a contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `groupId` | string | Yes | UUID of the contact group to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notifications History

**Slug:** `TOMTOM_GET_NOTIFICATIONS_HISTORY`

Tool to retrieve notifications history from TomTom. Use when you need to list past notifications sent within a specific time range (must be less than 24 hours).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | End date for the listing in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Defaults to current time if not provided. Date range from start to end must be less than 24 hours. |
| `from` | string | Yes | Beginning date for the listing in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Date range must be less than 24 hours. |
| `maxResults` | integer | No | Maximum number of items returned. Must be between 1 and 100. Default: 100. |
| `pageNumber` | integer | No | Page number for pagination. Must be greater than zero. Default: 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Notifications Settings

**Slug:** `TOMTOM_GET_NOTIFICATIONS_SETTINGS`

Tool to retrieve current notification settings. Use when you need to check notification configuration options.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Orbis Geocode

**Slug:** `TOMTOM_GET_ORBIS_GEOCODE`

Tool to geocode addresses using TomTom's Orbis Maps API. Use when converting address queries to geographic coordinates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for biasing search results |
| `lon` | number | No | Longitude for biasing search results |
| `ofs` | integer | No | Starting offset of returned results (default: 0, max: 1900) |
| `limit` | integer | No | Maximum number of results to return (default: 10, max: 100) |
| `query` | string | Yes | Address query string to geocode (must be properly URL encoded) |
| `radius` | integer | No | Search radius in meters around lat/lon |
| `language` | string | No | IETF BCP 47 language tag for search results (e.g., 'en-US') |
| `apiVersion` | string | No | Service version value. Current value is 1 |
| `countrySet` | string | No | Comma-separated ISO 3166-1 country codes to limit search (e.g., 'US,CA') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Orbis Places Autocomplete

**Slug:** `TOMTOM_GET_ORBIS_PLACES_AUTOCOMPLETE`

Tool to get autocomplete suggestions for place searches using TomTom Orbis Maps. Use when you need to recognize entities (brands, categories, locations) in a query and offer them as structured search terms.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for geographic biasing (must be paired with lon) |
| `lon` | number | No | Longitude for geographic biasing (must be paired with lat) |
| `limit` | integer | No | Maximum number of autocomplete results to return (default: 5, max: 10) |
| `query` | string | Yes | Search query string (must be URL-encoded in path) |
| `radius` | integer | No | Search radius in meters when using lat/lon (max: 5,000,000) |
| `language` | string | Yes | IETF language tag for response localization (e.g., en-US, fr-FR) |
| `resultSet` | string | No | Filter results by segment types: 'category', 'brand', or both |
| `apiVersion` | string | No | API version to use. Current value: 1 |
| `countrySet` | string | No | Comma-separated ISO country codes to restrict results (e.g., 'FR,ES') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Orbis Structured Geocode

**Slug:** `TOMTOM_GET_ORBIS_STRUCTURED_GEOCODE`

Tool to convert structured address fields into geographic coordinates using TomTom Orbis Maps API. Use when you have structured address components and need precise geocoding.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ofs` | integer | No | Result offset for pagination (default: 0, max: 1900) |
| `view` | string | No | Geopolitical view (e.g., 'Unified', 'AR', 'MA', 'IL', 'TW') |
| `limit` | integer | No | Maximum responses returned (default: 10, max: 100) |
| `language` | string | No | IETF language tag for results |
| `mapcodes` | string | No | Mapcode types (comma-separated, e.g., 'Local,International,Alternative') |
| `apiVersion` | string | No | Service version; current value is 1 |
| `postalCode` | string | No | Zip or postal code |
| `streetName` | string | No | Street name for structured address |
| `countryCode` | string | Yes | Two-letter country code (ISO 3166-1 alpha-2) - required |
| `crossStreet` | string | No | Cross street name |
| `municipality` | string | No | City or town designation |
| `streetNumber` | string | No | Street number for structured address |
| `entityTypeSet` | string | No | Geography entity type filters (comma-separated) |
| `countrySubdivision` | string | No | State or province |
| `extendedPostalCodesFor` | string | No | Index types for extended postal codes (comma-separated) |
| `municipalitySubdivision` | string | No | Sub or super city |
| `countryTertiarySubdivision` | string | No | Named area |
| `countrySecondarySubdivision` | string | No | County |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orbis Traffic Flow Tile

**Slug:** `TOMTOM_GET_ORBIS_TRAFFIC_FLOW_TILE`

Tool to retrieve Orbis traffic flow tile data in Protocol Buffer format. Use when you need traffic flow information for a specific map tile coordinate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | X coordinate on the zoom grid (0 to 2^z - 1). |
| `y` | integer | Yes | Y coordinate on the zoom grid (0 to 2^y - 1). |
| `z` | integer | Yes | Zoom level of the tile to be rendered (0-22). |
| `tags` | string | No | Comma-separated list of tags to include in response: road_category, road_subcategory, left_hand_traffic, road_closure, relative_speed, absolute_speed, part_of_two_way_road, openlr, display_class. |
| `format` | string ("pbf" | "json") | No | Response format. Note: Only 'pbf' (Protocol Buffer binary) is supported. JSON format will return an error. |
| `apiVersion` | string | No | API version, must be '1'. |
| `roadCategoryFilter` | string | No | Comma-separated list of road categories to filter: motorway, trunk, primary, secondary, tertiary, street, service, track. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Orbis Traffic Incident Details

**Slug:** `TOMTOM_GET_ORBIS_TRAFFIC_INCIDENT_DETAILS`

Tool to retrieve detailed Orbis traffic incidents by bounding box or IDs. Use when you need comprehensive incident data including events, delays, and geometry.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `t` | string | No | Traffic Model ID reference value (updated every minute, valid 2 min). |
| `ids` | string | No | Comma-separated incident IDs. Mutually exclusive with bbox. Max 5 IDs for GET requests. |
| `bbox` | string | No | Bounding box as minLon,minLat,maxLon,maxLat. Mutually exclusive with ids. Max area: 10,000 km². |
| `fields` | string | No | Specifies which response fields to include using nested notation (GraphQL-style). |
| `language` | string | No | Language code for output descriptions. |
| `apiVersion` | string | No | API version to call. |
| `categoryFilter` | string | No | Comma-separated incident types (numeric: 0-11, 14). Use to filter specific incident categories. |
| `timeValidityFilter` | string | No | Filter by occurrence timing: present or future (comma-separated). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Routing Batch Results

**Slug:** `TOMTOM_GET_ROUTING_BATCH`

Tool to download asynchronous batch routing results. Use when you need to retrieve the results of a previously submitted batch routing request using its batch ID. Returns HTTP 202 if processing is still ongoing (retry with Location header), or HTTP 200 with completed results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchId` | string | Yes | Unique batch identifier from the batch submission response's Location header |
| `waitTimeSeconds` | integer ("5" | "10" | "15" | "20" | "25" | "30" | "35" | "40" | "45" | "50" | "55" | "60" | "120") | No | Allowed wait time values for batch processing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Matrix Routing Async Status

**Slug:** `TOMTOM_GET_ROUTING_MATRIX_ASYNC_STATUS`

Tool to check the status of an asynchronous matrix routing job. Use when you need to poll the status of a previously submitted matrix routing request to determine if it's still processing, completed successfully, or failed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Unique job identifier returned from the matrix routing submission request. This ID is used to track the status of the asynchronous matrix calculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Satellite Tile

**Slug:** `TOMTOM_GET_SATELLITE_TILE`

Tool to retrieve satellite imagery map tiles at specified coordinates and zoom. Use when you need high-resolution satellite imagery for mapping applications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | Horizontal tile coordinate, from 0 to 2^zoom - 1. |
| `y` | integer | Yes | Vertical tile coordinate, from 0 to 2^zoom - 1. |
| `z` | integer | Yes | Zoom level from 0 (world) to 19 (highest detail). |
| `style` | string | No | Map style for satellite imagery. Use 'main' for primary tile styling. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Snap to Roads Batch Status

**Slug:** `TOMTOM_GET_SNAP_TO_ROADS_BATCH_STATUS`

Tool to check the status of an asynchronous Snap to Roads batch job. Use when you need to poll the status of a previously submitted snap to roads batch request to determine if it's still processing or completed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | string | Yes | Unique batch identifier obtained from the Asynchronous Snap to Roads Submission response. This ID is used to track the status of the asynchronous snap to roads request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Traffic Flow Tiles Raster

**Slug:** `TOMTOM_GET_TRAFFIC_FLOW_TILES_RASTER`

Tool to retrieve raster traffic flow map tiles for visualization. Use when you need to display real-time traffic flow conditions on a map.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | Horizontal tile coordinate in the tile grid (0 to 2^z - 1). |
| `y` | integer | Yes | Vertical tile coordinate in the tile grid (0 to 2^z - 1). |
| `z` | integer | Yes | Tile zoom level from 0 (world) to 22 (highest detail). |
| `style` | string ("absolute" | "relative" | "relative0" | "relative0-dark" | "relative-delay" | "reduced-sensitivity") | Yes | Rendering style for traffic display: 'absolute' (absolute speed), 'relative' (speed relative to free-flow), 'relative0' (relative with zero base), 'relative0-dark' (dark theme), 'relative-delay' (delay-based), or 'reduced-sensitivity' (reduced sensitivity to speed changes). |
| `tileSize` | integer ("256" | "512") | No | Size of the tile in pixels, either 256 or 512. Default is 256 if not specified. |
| `thickness` | integer | No | Line thickness for traffic flow visualization (1-20). Default is 10 if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Traffic Incident Details

**Slug:** `TOMTOM_GET_TRAFFIC_INCIDENT_DETAILS`

Tool to retrieve traffic incident details within a bounding box at a specified zoom level. Use when you need detailed incident information for map rendering or traffic analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `zoom` | integer | Yes | Zoom level (0-22). |
| `style` | string | Yes | Display style for rendering (e.g., s0, s1, s2, s3). |
| `format` | string ("xml" | "json" | "jsonp") | No | Response format. |
| `language` | string | No | ISO 639-1 language code for incident descriptions. |
| `geometries` | string ("original" | "shifted") | No | Vector geometry type options. |
| `projection` | string ("EPSG900913" | "EPSG4326") | No | Coordinate system projection options. |
| `bounding_box` | string | Yes | Area coordinates in format minY,minX,maxY,maxX (or minLat,minLon,maxLat,maxLon if using EPSG4326). |
| `expand_cluster` | boolean | No | Whether to list incidents within clusters. Default is false. |
| `traffic_model_id` | string | Yes | Traffic state reference ID or -1 for latest available traffic data. |
| `original_position` | boolean | No | Whether to return original incident position. Default is false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Traffic Incident Tile

**Slug:** `TOMTOM_GET_TRAFFIC_INCIDENT_TILE`

Tool to retrieve raster traffic incident map tiles showing traffic incidents at specified coordinates and zoom. Use when you need visual overlay of traffic incidents for custom map rendering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | Tile X coordinate, from 0 to 2^zoom - 1. |
| `y` | integer | Yes | Tile Y coordinate, from 0 to 2^zoom - 1. |
| `z` | integer | Yes | Zoom level from 0 (world) to 22 (max detail). |
| `style` | string ("s0" | "s0-dark" | "s1" | "s2" | "s3" | "night") | Yes | Tile style. s0=no clustering, s1=minor clustering, s2=medium clustering, s3=high clustering, night=dark theme. |
| `format` | string ("png" | "gif") | No | Image format to return (png or gif). |
| `tileSize` | integer | No | Tile dimensions in pixels (256 or 512). Default is 256. |
| `traffic_model_id` | string | No | Traffic Model ID. Use -1 for most recent traffic data, or omit for default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Traffic Incident Viewport

**Slug:** `TOMTOM_GET_TRAFFIC_INCIDENT_VIEWPORT`

Tool to retrieve traffic incidents within a viewport defined by bounding box and zoom level. Use when you need incident data for a specific map view with overview context.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `copyright` | boolean | Yes | Determines what copyright information to return (true/false). |
| `bounding_box` | string | Yes | Bounding box of the map viewport in EPSG:900913 projection format (minX,minY,maxX,maxY). |
| `content_type` | string ("json" | "xml") | Yes | The content type of the response structure. |
| `overview_box` | string | Yes | Bounding box of the overview map in EPSG:900913 projection format (minX,minY,maxX,maxY). |
| `bounding_zoom` | integer | Yes | Zoom level of the map viewport (0-22). |
| `overview_zoom` | integer | Yes | Zoom level of the overview map (0-22). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Geofencing Alert Rules

**Slug:** `TOMTOM_LIST_GEOFENCING_ALERT_RULES`

Tool to list geofencing alert rules with optional filtering. Use when you need to retrieve configured alert rules for projects, fences, or objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fence` | string | No | UUID of a Fence to filter by. Only alert rules associated with this fence will be returned. |
| `object` | string | No | UUID of an Object to filter by. Only alert rules associated with this object will be returned. |
| `enabled` | string | No | Filter by enabled status. Use 'true' to get only enabled alert rules, 'false' to get only disabled ones. |
| `project` | string | No | UUID of a Project to filter by. Only alert rules associated with this project will be returned. |
| `alertType` | string ("TRANSITION" | "DWELL" | "OBJECT_COUNT" | "PROXIMITY" | "ALL") | No | Alert type filter options |
| `maxResults` | integer | No | Maximum results per page. Must be between 1 and 100. Default is 100. |
| `pageNumber` | integer | No | Page number to retrieve. Must be greater than 0. Default is 1. |
| `notificationGroup` | string | No | UUID of a Notification Group to filter by. Only alert rules using this notification group will be returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Geofencing Alerts History

**Slug:** `TOMTOM_LIST_GEOFENCING_ALERTS_HISTORY`

Tool to retrieve geofencing alert history within a specified time range. Use when you need to query past alerts triggered by geofencing rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | Yes | ISO8601 timestamp indicating the end of the time range (e.g., 2019-08-29T16:00:00). |
| `from` | string | Yes | ISO8601 timestamp indicating the start of the time range (e.g., 2019-08-29T10:00:00). |
| `alertType` | string | No | Type of alert to filter by (e.g., TRANSITION). |
| `maxResults` | integer | No | Maximum number of results to return per page. |
| `pageNumber` | integer | No | Page number for pagination (starts at 1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Geofencing Objects

**Slug:** `TOMTOM_LIST_GEOFENCING_OBJECTS`

Tool to list all tracked objects in the TomTom Geofencing system. Use when you need to retrieve all objects currently being tracked for geofencing operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Location History Objects

**Slug:** `TOMTOM_LIST_LOCATION_HISTORY_OBJECTS`

Tool to list objects with location history. Use when you need to retrieve all objects being tracked for location history.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Notification Groups

**Slug:** `TOMTOM_LIST_NOTIFICATION_GROUPS`

Tool to list notification contact groups. Use when you need to retrieve available contact groups for notifications. Note: This service will be decommissioned on January 31, 2027.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `maxResults` | integer | No | Maximum items returned per page. Range: 1-100. Default: 100. |
| `pageNumber` | integer | No | Page number to return, must be greater than zero. Default: 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List POI Categories

**Slug:** `TOMTOM_LIST_POI_CATEGORIES`

Tool to retrieve all POI categories supported by TomTom Search API. Use when you need the complete list of category IDs and names for searching POIs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | IETF language tag for category names (e.g., 'en-US', 'fr-FR'). Defaults to English if not specified or unavailable. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Sprite Versions

**Slug:** `TOMTOM_LIST_SPRITE_VERSIONS`

Tool to list available sprite asset versions. Use when you need to know which sprite versions are available after obtaining a valid API key.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Copyrights

**Slug:** `TOMTOM_MAP_DISPLAY_COPYRIGHTS`

Tool to retrieve copyright information for a specific map tile. Use when you need to display or verify attribution for a given tile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | X coordinate of the map tile (non-negative). |
| `y` | integer | Yes | Y coordinate of the map tile (non-negative). |
| `zoom` | integer | Yes | Map zoom level (non-negative). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### MAP_DISPLAY_RASTER_TILE

**Slug:** `TOMTOM_MAP_DISPLAY_RASTER_TILE`

Tool to retrieve a raster map tile for specified coordinates and zoom. Use when you need direct tile image data for custom map rendering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `X` | integer | Yes | Tile X coordinate (integer ≥ 0). |
| `Y` | integer | Yes | Tile Y coordinate (integer ≥ 0). |
| `view` | string | No | View parameter, typically 'Unified'. |
| `zoom` | integer | Yes | Zoom level between 0 (world) and 22 (max detail). |
| `layer` | string ("basic" | "hybrid" | "labels") | No | Map layer type: 'basic' (full map data), 'hybrid' (roads/borders/labels without polygons), or 'labels' (text labels overlay). |
| `style` | string ("main" | "night") | No | Visual theme of the map: 'main' (daytime) or 'night' (dark mode). |
| `format` | string ("png" | "jpg") | No | Image format to return. Note: JPG is only supported for layer='basic', style='main', and zoom<7. Use PNG for all other cases. |
| `language` | string | No | Language code for map labels, e.g., 'en-GB'. |
| `tileSize` | integer ("256" | "512") | No | Tile size in pixels, either 256 or 512. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Map Display Static Image

**Slug:** `TOMTOM_MAP_DISPLAY_STATIC_IMAGE`

Tool to fetch a static map snapshot given center coords and zoom. Use when you need a standalone map image for display.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bbox` | string | No | Bounding box 'min_lon,min_lat,max_lon,max_lat'. Required if 'center' is not provided. Mutually exclusive with 'center' parameter. |
| `view` | string | No | Map view parameter, e.g., 'Unified', 'Auto', 'AR'. |
| `zoom` | integer | No | Zoom level between 0 (world) and 20 (max detail). Default: 12. |
| `layer` | string ("basic" | "hybrid" | "labels") | No | Map layer type. |
| `style` | string ("main" | "night") | No | Map style. |
| `width` | integer | No | Image width in pixels (1-8192). |
| `center` | string | No | Coordinates of the map center as 'lon,lat' (longitude,latitude). Longitude range: -180 to 180, Latitude range: -85 to 85. Required if 'bbox' is not provided. |
| `format` | string ("png" | "jpg") | No | Output image format. |
| `height` | integer | No | Image height in pixels (1-8192). |
| `markers` | string | No | Overlay markers; format 'color\|label\|lat,lon;color\|label\|lat,lon'. |
| `language` | string | No | Language code for map labels, e.g., 'en-US'. |
| `tileSize` | integer ("256" | "512") | No | Tile size in pixels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Map Display WMS GetMap

**Slug:** `TOMTOM_MAP_DISPLAY_WMS_GET_MAP`

Tool to retrieve a map image via WMS GetMap. Use when you need georeferenced map layers for custom rendering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `crs` | string | No | Coordinate Reference System for WMS 1.3.0, e.g., 'EPSG:4326' |
| `srs` | string | No | Coordinate Reference System for WMS 1.1.1, e.g., 'EPSG:4326' |
| `bbox` | string | Yes | Bounding box in 'minx,miny,maxx,maxy' format |
| `time` | string | No | Time parameter for time-enabled layers |
| `width` | integer | Yes | Image width in pixels, must be >= 1 |
| `format` | string | Yes | Image format, e.g., 'image/png' or 'image/jpeg' |
| `height` | integer | Yes | Image height in pixels, must be >= 1 |
| `layers` | string | Yes | Comma-separated list of map layers to display |
| `styles` | string | No | Comma-separated list of layer styles; empty for default |
| `bgcolor` | string | No | Background color in hex, e.g., '0xFFFFFF' |
| `request` | string | Yes | Request type, must be 'GetMap' |
| `service` | string | Yes | Service type, must be 'WMS' |
| `version` | string ("1.1.1" | "1.3.0") | Yes | WMS version to use |
| `elevation` | string | No | Elevation parameter for dimension-enabled layers |
| `exceptions` | string | No | Exception output format, e.g., 'INIMAGE' |
| `transparent` | boolean | No | Transparency flag; TRUE for transparent background |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Matrix Routing

**Slug:** `TOMTOM_MATRIX_ROUTING`

Tool to calculate travel time and distance matrix between multiple locations. Use when you require a matrix of travel times and distances between multiple origins and destinations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `options` | object | No | Optional routing and vehicle profile settings |
| `origins` | array | Yes | List of origin coordinates (must contain at least one origin) |
| `destinations` | array | Yes | List of destination coordinates (must contain at least one destination) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Nearby Search

**Slug:** `TOMTOM_NEARBY_SEARCH`

Tool to find Points of Interest near a specified location. Use after confirming coordinates to discover nearby POIs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude of the center point for the search |
| `lon` | number | Yes | Longitude of the center point for the search |
| `limit` | integer | No | Maximum number of results to return (default: 10, max: 100) |
| `radius` | integer | No | Search radius in meters (default: 10000, max: 50000) |
| `brandSet` | string | No | Comma-separated list of brand IDs to restrict the results |
| `countrySet` | string | No | Comma-separated list of country codes to restrict results |
| `minPowerKW` | integer | No | Minimum power in kW for charging stations |
| `categorySet` | string | No | Comma-separated list of category IDs to restrict the search |
| `connectorSet` | string | No | Comma-separated list of connector IDs for charging stations |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Edit Contact Group (Partial)

**Slug:** `TOMTOM_PATCH_NOTIFICATIONS_GROUPS_GROUPID`

Tool to partially update a contact group in TomTom Notifications API. Use when you need to edit the name, webhook URLs, or email addresses of an existing contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for the contact group |
| `emails` | array | No | List of email addresses for notifications (max 20) |
| `group_id` | string | Yes | UUID of the contact group to update |
| `webhook_urls` | array | No | List of webhook URLs for message delivery (max 20) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Points of Interest Search

**Slug:** `TOMTOM_POINTS_OF_INTEREST_SEARCH`

Tool to search for points of interest by query. Use when you need POI suggestions by name or category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for location bias |
| `lon` | number | No | Longitude for location bias |
| `ofs` | integer | No | Starting offset for returned results |
| `view` | string | No | Restrict results to specified map view region |
| `limit` | integer | No | Maximum number of results to return |
| `query` | string | Yes | Search term, category, or brand name |
| `idxSet` | string | No | Comma-separated list of indices to include (POI, Geography) |
| `radius` | integer | No | Radius in meters for search area |
| `fuelSet` | string | No | Comma-separated fuel types |
| `brandSet` | string | No | Comma-separated list of brand names |
| `language` | string | No | Language tag for result labels (e.g., 'en-US', 'fr-FR', 'de-DE') |
| `timeZone` | boolean | No | Output local time for opening hours |
| `typeahead` | boolean | No | Return incomplete results as users type |
| `countrySet` | string | No | Comma-separated ISO 3166-1 alpha-2 country codes for restricting search |
| `entityType` | string | No | Restrict search to specific entity type |
| `categorySet` | string | No | Comma-separated list of category IDs |
| `relatedPois` | string | No | Return related POIs (e.g., 'child', 'all') |
| `categoryBias` | string | No | Categories to bias in result ranking |
| `connectorSet` | string | No | Comma-separated EV connector types |
| `openingHours` | string | No | Filter POIs by opening hours (e.g., 'nextSevenDays') |
| `maxFuzzyLevel` | integer | No | Maximum typo-correction level |
| `minFuzzyLevel` | integer | No | Minimum typo-correction level |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocode

**Slug:** `TOMTOM_REVERSE_GEOCODE`

Tool to convert geographic coordinates into a human-readable address. Use when you need to obtain address information from latitude and longitude values.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude in decimal degrees. |
| `lon` | number | Yes | Longitude in decimal degrees. |
| `number` | string | No | Street number for more precise results. |
| `radius` | integer | No | Search radius in meters (default: 100). |
| `language` | string | No | Language for the results, e.g., 'en-US'. |
| `entityType` | string | No | Restrict results to a specific entity type, e.g., 'CountrySubdivision'. |
| `returnRoadUse` | boolean | No | Include road use information (true or false). |
| `returnSpeedLimit` | boolean | No | Include speed limit information (true or false). |
| `allowFreeformNewline` | boolean | No | Allow or disallow newlines in freeform address output. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocode Cross Street

**Slug:** `TOMTOM_REVERSE_GEOCODE_CROSS_STREET`

Tool to find the nearest cross street or intersection for given geographic coordinates. Use when you need to identify street intersections near a specific latitude/longitude position.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ext` | string ("json" | "jsonp" | "js" | "xml") | No | Expected response format. Use 'json' for JSON response. |
| `limit` | integer | No | Maximum number of cross-streets to return (default: 1). |
| `radius` | integer | No | Maximum distance in meters from the specified position for the reverse geocoder to consider (default: 10000). |
| `heading` | number | No | Directional heading in degrees, measured clockwise from north (0=north, 90=east, 180=south, 270=west). |
| `language` | string | No | Language for search results (IETF language tag, e.g., 'en-US', 'de-DE'). |
| `position` | string | Yes | Comma-separated latitude and longitude (e.g., '37.8328,-122.27669'). Latitude must be between -90 and 90, longitude between -180 and 180. |
| `spatialKeys` | boolean | No | If true, the response will include proprietary geospatial keys for the specified location. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocode Orbis

**Slug:** `TOMTOM_REVERSE_GEOCODE_ORBIS`

Tool to convert geographic coordinates into a human-readable address using TomTom's Orbis Maps API. Use when you need detailed address information from latitude and longitude values with Orbis data coverage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string | No | Geopolitical view context for the response. Valid values include 'Unified', 'AR' (Argentina), 'MA' (Morocco), 'IL' (Israel). |
| `radius` | integer | No | Maximum search distance in meters from the specified position (default: 10000). |
| `heading` | number | No | Vehicle directional heading in degrees. Valid values range from -360 to 360. Used to determine the direction of travel for road matching. |
| `language` | string | No | Response language using IETF BCP 47 language tags (e.g., 'en-US', 'nl-NL'). Default is NGT (Neutral Ground Truth). |
| `position` | string | Yes | Latitude and longitude coordinates in 'lat,lon' format (e.g., '52.377956,4.897070'). Latitude must be between -90 and 90, longitude between -180 and 180. |
| `entityType` | string | No | Filter results by specific geography entity types (e.g., 'Country', 'Municipality', 'PostalCodeArea', 'CountrySubdivision'). |
| `returnMatchType` | boolean | No | Include match type information in the response to indicate how the position was matched to the result. |
| `returnRoadClass` | string | No | Enable road classification information in the response. Use 'Functional' to include functional road class data. |
| `returnSpeedLimit` | boolean | No | Include posted speed limit information in the response where available (default: false). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Along Route

**Slug:** `TOMTOM_SEARCH_ALONG_ROUTE`

Tool to search for Points of Interest along a specified route with detour time constraints. Use when you need to find POIs (restaurants, gas stations, hotels) accessible from a planned route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string | No | Geopolitical view context |
| `limit` | integer | No | Maximum number of results to return (1-20, default: 10) |
| `query` | string | Yes | Search query for POI (e.g., 'pizza', 'gas station', 'hotel') |
| `route` | object | Yes | Route definition with at least 2 coordinate points to search along |
| `sortBy` | string | No | Sort results by: 'detourTime', 'detourDistance', or 'detourOffset' |
| `fuelSet` | string | No | Comma-separated list of fuel types |
| `brandSet` | string | No | Comma-separated list of brand names to restrict results |
| `language` | string | No | IETF language tag for response language |
| `mapcodes` | string | No | Include mapcode formats: 'Local', 'International', 'Alternative' |
| `timeZone` | string | No | Include timezone information (e.g., 'iana') |
| `typeahead` | boolean | No | Enable typeahead/predictive search mode (default: false) |
| `apiVersion` | string | No | API version to use (current version is '1') |
| `maxPowerKW` | number | No | Maximum power in kW for EV charging stations |
| `minPowerKW` | number | No | Minimum power in kW for EV charging stations |
| `categorySet` | string | No | Comma-separated list of category IDs to restrict the search |
| `connectorSet` | string | No | Comma-separated list of EV connector types |
| `detourOffset` | boolean | No | Calculate distance from route start point (default: false) |
| `openingHours` | string | No | Include opening hours information (e.g., 'nextSevenDays') |
| `maxDetourTime` | integer | Yes | Maximum detour time in seconds (0-3600) |
| `spreadingMode` | string | No | Spread results along route (e.g., 'auto') |
| `vehicleTypeSet` | string | No | Comma-separated vehicle types (Car, Truck) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Along Route (v2)

**Slug:** `TOMTOM_SEARCH_ALONG_ROUTE_V2`

Tool to search for Points of Interest along a specified route using Search API v2. Use when you need to find POIs accessible from a planned route with detour constraints.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string | No | Geopolitical view context |
| `limit` | integer | No | Maximum number of results to return (1-20, default: 10) |
| `query` | string | Yes | Search query for POI (e.g., 'pizza', 'gas station', 'hotel') |
| `route` | object | Yes | Route definition with at least 2 coordinate points to search along |
| `sortBy` | string | No | Sort results by: 'detourTime', 'detourDistance', or 'detourOffset' |
| `fuelSet` | string | No | Comma-separated list of fuel types |
| `brandSet` | string | No | Comma-separated list of brand names to restrict results |
| `language` | string | No | IETF language tag for response language |
| `mapcodes` | string | No | Include mapcode formats: 'Local', 'International', 'Alternative' |
| `timeZone` | string | No | Include timezone information (e.g., 'iana') |
| `maxPowerKW` | number | No | Maximum power in kW for EV charging stations |
| `minPowerKW` | number | No | Minimum power in kW for EV charging stations |
| `categorySet` | string | No | Comma-separated list of category IDs to restrict the search |
| `connectorSet` | string | No | Comma-separated list of EV connector types |
| `detourOffset` | boolean | No | Calculate distance from route start point (default: false) |
| `openingHours` | string | No | Include opening hours information (e.g., 'nextSevenDays') |
| `maxDetourTime` | integer | Yes | Maximum detour time in seconds (0-3600) |
| `vehicleTypeSet` | string | No | Comma-separated vehicle types (Car, Truck) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Geometry

**Slug:** `TOMTOM_SEARCH_GEOMETRY`

Tool to search for POIs within geometric areas (circles or polygons). Use when you need to find points of interest constrained to specific geographic boundaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of search results to return (default: 10) |
| `query` | string | Yes | Search query string (e.g., 'pizza', 'restaurant'). Must be properly URL encoded internally |
| `idxSet` | string | No | Comma-separated indexes to use for search: Addr, Geo, PAD, POI, Str, Xstr |
| `language` | string | No | Language for search results (IETF language tag, case insensitive) |
| `geometryList` | array | Yes | List of geometric areas (circles or polygons) to search within. At least one geometry is required |
| `extendedPostalCodesFor` | string | No | Comma-separated indexes for extended postal codes: Addr, Geo, PAD, POI, Str, XStr |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Orbis Category Search

**Slug:** `TOMTOM_SEARCH_ORBIS_CATEGORY`

Tool to search for Points of Interest by category using TomTom Orbis Maps API. Use when you need to find POIs within specific categories using the Orbis mapping service.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for location bias (decimal degrees) |
| `lon` | number | No | Longitude for location bias (decimal degrees) |
| `limit` | integer | No | Maximum number of results to return (default: 10, max: 100) |
| `query` | string | Yes | URL-encoded search string for category search (e.g., 'pizza', 'restaurant') |
| `radius` | integer | No | Search radius in meters (requires lat & lon) |
| `language` | string | No | IETF language tag for response localization (e.g., 'en-US', 'fr-FR') |
| `typeahead` | boolean | No | Boolean enabling predictive search mode for partial queries |
| `apiVersion` | string | No | API version, currently '1' for Orbis Maps |
| `countrySet` | string | No | Comma-separated ISO country codes to limit search (e.g., 'FR,ES') |
| `categorySet` | string | No | Comma-separated category IDs for filtering results |
| `openingHours` | string | No | Use 'nextSevenDays' to include POI operating hours in response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Orbis Places Search

**Slug:** `TOMTOM_SEARCH_ORBIS_PLACES`

Tool to perform fuzzy search for addresses and points of interest using TomTom Orbis Maps API. Use when you need flexible matching on free-form location queries with the Orbis mapping service.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for location bias (decimal degrees) |
| `lon` | number | No | Longitude for location bias (decimal degrees) |
| `ofs` | integer | No | Starting offset of returned results for pagination |
| `limit` | integer | No | Maximum number of results to return (default: 10, max: 100) |
| `query` | string | Yes | Search query string (e.g., city name, address, POI name) |
| `radius` | integer | No | Search radius in meters (requires lat & lon) |
| `brandSet` | string | No | Comma-separated brand names for filtering results |
| `language` | string | No | IETF language tag for response localization (e.g., 'en-US', 'fr-FR') |
| `apiVersion` | string | No | API version, currently '1' for Orbis Maps |
| `countrySet` | string | No | Comma-separated ISO country codes to limit search (e.g., 'FR,ES') |
| `categorySet` | string | No | Comma-separated category IDs for filtering results |
| `openingHours` | string | No | Use 'nextSevenDays' to include POI operating hours in response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Orbis POI Search

**Slug:** `TOMTOM_SEARCH_ORBIS_POI`

Tool to search for points of interest using TomTom Orbis Maps API. Use when you need POI suggestions by name or category from the Orbis dataset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | No | Latitude for coordinate biasing |
| `lon` | number | No | Longitude for coordinate biasing |
| `limit` | integer | No | Maximum results (default 10, max 100) |
| `query` | string | Yes | Search term, category, or brand name |
| `radius` | integer | No | Search radius in meters |
| `typeahead` | boolean | No | Enables predictive mode, default false |
| `apiVersion` | string | No | Service version, currently 1 |
| `countrySet` | string | No | Comma-separated ISO country codes |
| `categorySet` | string | No | POI category IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Snap to Roads (Sync)

**Slug:** `TOMTOM_SNAP_TO_ROADS_SYNC`

Tool to snap GPS points to the road network synchronously. Maps raw GPS coordinates to actual road geometry, useful for map matching and route reconstruction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Nested field selectors for response data. Use to customize which fields are returned. |
| `points` | string | Yes | Semicolon separated list of points with longitude,latitude pairs (min 2, max 5000 points). Example: '4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629' |
| `headings` | string | No | Semicolon separated headings in degrees (0=North, 90=East). Must match the number of points if provided. |
| `timestamps` | string | No | Semicolon separated ISO 8601 timestamps. Must match the number of points if provided. |
| `vehicle_type` | string ("PassengerCar" | "Bus" | "Truck" | "Emergency" | "Taxi") | No | Vehicle types supported by the Snap to Roads API. |
| `offroad_margin` | number | No | Offroad margin in meters (metric) or feet (imperial). Points beyond this distance from roads are marked as off-road. |
| `measurement_system` | string ("metric" | "imperial" | "auto") | No | Measurement system for distances and dimensions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Structured Geocode

**Slug:** `TOMTOM_STRUCTURED_GEOCODE`

Tool to convert structured address fields into coordinates. Use after collecting street, city, and postal code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | Your TomTom API Key |
| `lat` | number | No | Latitude to bias results |
| `lon` | number | No | Longitude to bias results |
| `city` | string | No | City name |
| `view` | string | No | Map view for biasing results, e.g., 'Unified', 'EU', 'IN' |
| `limit` | integer | No | Maximum number of results to return (1–100) |
| `radius` | integer | No | Radius in meters to bias results around lat/lon |
| `language` | string | No | IETF BCP 47 language tag for response |
| `postalCode` | string | No | Postal code |
| `streetName` | string | No | Street name |
| `countryCode` | string | Yes | Country ISO 3166-1 alpha-2 code (required) |
| `municipality` | string | No | Administrative municipality |
| `streetNumber` | string | No | Street number |
| `freeformAddress` | string | No | Complete address as free-form string. Overrides structured fields. |
| `countrySubdivision` | string | No | State, province, or region |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Traffic Incidents

**Slug:** `TOMTOM_TRAFFIC_INCIDENTS`

Tool to retrieve detailed traffic incidents within a bounding box. Use when you need incident details for a defined map area.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated incident fields to include, e.g., 'id,geometry,properties'. |
| `format` | string ("json" | "xml") | No | Response format. |
| `max_lat` | number | Yes | Maximum latitude (northeast) of bounding box. |
| `max_lon` | number | Yes | Maximum longitude (northeast) of bounding box. |
| `min_lat` | number | Yes | Minimum latitude (southwest) of bounding box. |
| `min_lon` | number | Yes | Minimum longitude (southwest) of bounding box. |
| `language` | string | No | Language code for the response. |
| `projection` | string | No | Map projection for geometry coordinates. |
| `original_position` | boolean | No | Whether to include original position of incidents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Geofencing Secret

**Slug:** `TOMTOM_UPDATE_GEOFENCING_SECRET`

Tool to change the customer secret for TomTom Geofencing API. Use when you need to update or rotate the authentication secret for geofencing operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secret` | string | Yes | The current/old secret value that needs to be replaced |
| `newSecret` | string | Yes | The new secret value to be set |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Notifications Group

**Slug:** `TOMTOM_UPDATE_NOTIFICATIONS_GROUP`

Tool to update an existing contact group in TomTom Notifications API. Use when you need to modify the name, webhook URLs, or email addresses of a contact group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the contact group |
| `emails` | array | No | List of email addresses for notifications (max 20) |
| `group_id` | string | Yes | UUID of the contact group to update |
| `webhook_urls` | array | No | List of webhook URLs for message delivery (max 20) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |