Skip to main content
Tomtom logo
  • Category: places & weather
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 82
  • Triggers: 0
  • Slug: TOMTOM
  • Version: 20261101_00

Tools

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_ASSETS_LIST_SPRITESTool to list available sprites for a given asset version. Use after determining the assetVersion.

Input Parameters

string
required
A valid TomTom API key.
string
API version of the service. Current value is ‘1’.
string
required
The chosen version of the asset in format MAJOR.MINOR.PATCH-BUILD (e.g., ‘0.6.1-0’). Wildcards are supported, e.g., ‘0.*’.
array
Optional filter for sprite categories. Possible values: ‘map’, ‘trafficFlow’, ‘trafficIncidents’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_ASSETS_LIST_STYLESTool to list available map styles. Use after selecting an asset version to retrieve style options.

Input Parameters

string
required
The API version of the Orbis Maps service to call. This query parameter takes precedence over any header value.
string
required
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
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CALCULATE_LONG_DISTANCE_EV_ROUTETool to calculate long-distance electric vehicle routes with optimal charging stops. Use when planning EV trips that require charging along the route.

Input Parameters

boolean
Include real-time traffic data in route calculation.
string
required
Colon-delimited list of route waypoint coordinates in format ‘lat,lon:lat,lon’. Minimum 2 locations (origin and destination), maximum 152 locations.
string
Route calculation strategy (e.g., ‘fastest’, ‘shortest’, ‘eco’).
string
Mode of transport (e.g., ‘car’).
number
Maximum battery capacity in kilowatt-hours (kWh).
string
Must be ‘electric’ for EV routing.
object
Charging parameters for the EV route calculation.
number
required
Current battery charge in kilowatt-hours (kWh).
number
required
Minimum required charge at destination in kilowatt-hours (kWh).
number
required
Minimum charge level at intermediate charging stops in kilowatt-hours (kWh).
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CALCULATE_MATRIX_ROUTING_SYNCTool 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

object
Optional routing and vehicle configuration parameters.
array
required
Non-empty list of origin locations. Matrix size (origins × destinations) must not exceed 200 cells for synchronous endpoint.
array
required
Non-empty list of destination locations. Matrix size (origins × destinations) must not exceed 200 cells for synchronous endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CALCULATE_REACHABLE_RANGETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CALCULATE_ROUTECalculate routes between an origin and destination with optional waypoints and traffic consideration. The returned routes include summaries, legs and sections.

Input Parameters

string
required
Destination coordinates as ‘lat,lon’.
string
Features to avoid (comma-separated), e.g., ‘tollRoads,highways’.
string
required
Origin coordinates as ‘lat,lon’.
string
Additional report fields, e.g., ‘effectiveSettings,travelTimes’.
boolean
Whether to consider live traffic data.
string
Language for instructions and results.
string
Arrival time in ISO 8601 format.
string
Departure time in ISO 8601 format.
string
Intermediate waypoints as ‘lat,lon:lat,lon’.
string ("fastest" | "shortest" | "eco" | "thrilling")
Route calculation strategy.
string ("car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle" | "pedestrian")
Mode of transport.
string
Comma-separated list of section types to include, e.g., ‘traffic,toll’.
string ("coded" | "text" | "tagged")
Format of guidance instructions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CALCULATE_ROUTE_WITH_BODYTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CATEGORY_SEARCHTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_NOTIFICATIONS_GROUPSTool 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

string
Name of the contact group (optional, max 255 characters)
array
List of email addresses to receive notifications (max 20 emails)
array
List of webhook URLs to receive notifications (max 20 URLs)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_ROUTING_BATCHSubmit multiple route calculation queries in a single TomTom routing batch. Asynchronous responses provide a batch ID and location for later retrieval; when the batch completes during submission, this tool does not return the completed route results.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_ROUTING_BATCH_SYNCTool 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

array
required
Array of batch request items. Maximum 100 items allowed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_ROUTING_MATRIX_ASYNCTool 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

object
Optional routing configuration including time, route type, travel mode, and traffic settings
array
required
Non-empty list of origin points with latitude/longitude coordinates
array
required
Non-empty list of destination points with latitude/longitude coordinates

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_ROUTING_WAYPOINTOPTIMIZATIONTool 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

object
Optional routing configuration and constraints
array
required
List of waypoints to optimize. Must contain 2-12 waypoints including origin and destination

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_SEARCH_GEOMETRYFILTERTool 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

string ("json" | "jsonp" | "js" | "xml")
Expected response format. Default is json.
array
required
List of POIs to filter by the specified geometries. Maximum 50 POIs per request.
array
required
List of geometry filters (circles or polygons) to apply. Each geometry defines a spatial boundary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_SNAP_TO_ROADSTool 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

array
required
Array of GPS points to snap to roads. Minimum 2 points, maximum 5000 points.
string
API version number. Current value is ‘1’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_CREATE_SNAP_TO_ROADS_BATCHTool 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

array
required
Array of batch items. Each item contains a query string and GPS points to snap to the road network.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_DELETE_NOTIFICATIONS_HISTORYClear the account’s entire notifications history. The response may include a deletion timestamp and operation status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_DOWNLOAD_BATCH_SEARCH_ASYNCDownload results of an asynchronous batch search using its batch ID. If the batch is still processing, the tool raises an error with the retry location from the response when available.

Input Parameters

string
required
Unique batch identifier from the submission response
integer
Maximum wait time in seconds before returning 202 if still processing. Allowed values: 5-60 or 120 (default).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_DOWNLOAD_MATRIX_ROUTING_ASYNC_RESULTTool 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

string
required
Unique job identifier from the async matrix routing submission response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_DOWNLOAD_SNAP_TO_ROADS_ASYNC_RESULTDownload results of a completed asynchronous Snap to Roads batch job using its job ID. Batch items include status codes and may contain projected points, reconstructed routes, distance metrics, or error responses.

Input Parameters

string
required
Unique job identifier from the asynchronous Snap to Roads batch submission response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_EV_CHARGING_STATIONS_AVAILABLETool to retrieve EV charging station availability info. Use when you have the chargingAvailability ID (from POI search dataSources) to get live availability.

Input Parameters

number
Maximum charging power in kilowatts to filter results.
number
Minimum charging power in kilowatts to filter results.
string
Comma-separated list of connector types to filter results (e.g., ‘IEC62196Type2CableAttached,IEC62196Type2Outlet’).
string
required
The chargingAvailability ID (UUID format) retrieved from the dataSources section of a POI search result. Example: ‘00112233-4455-6677-8899-aabbccddeeff’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_FLOW_SEGMENT_DATATool to retrieve traffic flow data for a specific road segment. Use when you need current and free flow speeds for given coordinates.

Input Parameters

string ("KMPH" | "MPH")
Unit for speed values.
integer
required
Zoom level for the flow segment data (0-22).
string
required
Center point of the segment in ‘lat,lon’ format.
string
required
Display style of the flow data.
string ("json" | "xml")
required
Response format of the data.
boolean
Whether to include OpenLR descriptors in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_FUZZY_SEARCHTool to perform a fuzzy search for addresses and points of interest. Use when you need flexible matching on free-form location queries.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GEOCODE_QUERYTool to convert a free-form address query into geographic coordinates. Use when you need to geocode an address string without structured fields.

Input Parameters

string ("json" | "jsonp" | "js" | "xml")
Expected response format.
number
Latitude where results should be biased. Supplying a lat/lon without a radius will return search results biased to that point.
number
Longitude where results should be biased. Supplying a lat/lon without a radius will return search results biased to that point.
integer
Starting offset of the returned results within the full result set.
string ("Unified" | "IN" | "PK" | "IL" | "MA")
Geopolitical view for geography rendering
integer
Maximum number of search results that will be returned.
string
required
Address query string to geocode. Must be properly URL encoded.
integer
If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.
string
Top left position of the bounding box. This is specified as a comma separated string composed of lat,lon.
string
Bottom right position of the bounding box. This is specified as a comma separated string composed of lat,lon.
string
Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive.
boolean
If set, the query will be interpreted as a partial input and the search will enter predictive mode.
string
Comma separated string of country codes to limit the search to specified countries.
boolean
If set, the query will be interpreted as a stored geocode and will be billed according to terms of use.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_AUTOCOMPLETETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_COPYRIGHTSTool to retrieve copyright information for TomTom map tiles. Use when you need to display attribution or copyright notices for map content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_GEOMETRY_SEARCHTool 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

integer
Maximum number of search results to return (default: 10)
string
required
Search query string (e.g., ‘restaurant’, ‘pizza’). Will be URL-encoded automatically.
string
Comma-separated list of indexes to use for search: Addr, Geo, PAD, POI, Str, Xstr
string
IETF language tag for response localization (e.g., ‘en-US’)
string
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}]’
string
Comma-separated indexes for which extended postal codes should be included: Addr, Geo, PAD, POI, Str, XStr

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_HILLSHADE_TILETool to retrieve hillshade terrain map tiles for specified coordinates and zoom. Use when you need terrain elevation shading overlays for map visualization.

Input Parameters

integer
required
Tile X coordinate (0 to 2^zoom - 1).
integer
required
Tile Y coordinate (0 to 2^zoom - 1).
integer
required
Zoom level between 0 (world) and 13 (maximum detail for hillshade tiles).
string
Tile style type. Currently only ‘main’ is supported for hillshade tiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_INCIDENT_VIEWPORTTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAP_COPYRIGHTS_BOUNDING_BOXTool to retrieve copyright information for a geographic bounding box. Use when you need attribution for a specific map area defined by coordinates.

Input Parameters

string ("json" | "jsonp" | "xml")
Format of the response (json, jsonp, or xml).
number
required
Maximum latitude coordinate of bounding box.
number
required
Maximum longitude coordinate of bounding box.
number
required
Minimum latitude coordinate of bounding box.
number
required
Minimum longitude coordinate of bounding box.
string
Specifies the jsonp callback method. Only used when format is jsonp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAP_COPYRIGHTS_CAPTIONTool to retrieve the copyright caption text for TomTom maps. Use when you need to display attribution or copyright notices on map displays.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAP_COPYRIGHTS_FORMATTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAPS_ORBIS_MAP_TILETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAPS_ORBIS_TRAFFIC_TILETool 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

integer
required
X coordinate on zoom grid (0 to 2^zoom-1). Represents the horizontal tile position.
integer
required
Y coordinate on zoom grid (0 to 2^zoom-1). Represents the vertical tile position.
integer
required
Tile zoom level (0-22). Higher values provide more detail.
array
Filters response tags. Available tags: icon_category, left_hand_traffic, magnitude_of_delay, road_category, road_subcategory.
string
Output language for incident descriptions. Use standard language codes.
string
API version to use for the request.
string
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.
string
Traffic Model ID reference. Use ‘-1’ to return the most recent traffic data.
string
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.
string
Filters incidents by occurrence timing. Use ‘present’ for current incidents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAP_STYLE_METADATATool 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

string
Resource variant name. Only applicable when resourceVersion is provided. Filters metadata by the specified variant.
string
Specific version or partial version with wildcard (e.g., ‘20.’, ‘20.0.2-’). When provided, retrieves metadata for the specified version only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_MAP_STYLESTool 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

string
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’).
string
Point-of-interest style to include in the merged style. Common values: ‘poi_main’, ‘poi_dynamic’.
string
required
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.
string
Traffic flow display style to include in the merged style. Common values: ‘flow_absolute’, ‘flow_relative0’.
string
Traffic incident visualization style to include in the merged style. Common values: ‘incidents_day’, ‘incidents_night’, ‘incidents_s0’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_NOTIFICATIONS_GROUPS_GROUPIDTool 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

string
required
UUID of the contact group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_NOTIFICATIONS_HISTORYTool 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

string
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.
string
required
Beginning date for the listing in ISO 8601 format (YYYY-MM-DDThh:mm:ss). Date range must be less than 24 hours.
integer
Maximum number of items returned. Must be between 1 and 100. Default: 100.
integer
Page number for pagination. Must be greater than zero. Default: 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_NOTIFICATIONS_SETTINGSTool to retrieve current notification settings. Use when you need to check notification configuration options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ORBIS_GEOCODETool to geocode addresses using TomTom’s Orbis Maps API. Use when converting address queries to geographic coordinates.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ORBIS_PLACES_AUTOCOMPLETETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ORBIS_STRUCTURED_GEOCODETool 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

integer
Result offset for pagination (default: 0, max: 1900)
string
Geopolitical view (e.g., ‘Unified’, ‘AR’, ‘MA’, ‘IL’, ‘TW’)
integer
Maximum responses returned (default: 10, max: 100)
string
IETF language tag for results
string
Mapcode types (comma-separated, e.g., ‘Local,International,Alternative’)
string
Service version; current value is 1
string
Zip or postal code
string
Street name for structured address
string
required
Two-letter country code (ISO 3166-1 alpha-2) - required
string
Cross street name
string
City or town designation
string
Street number for structured address
string
Geography entity type filters (comma-separated)
string
State or province
string
Index types for extended postal codes (comma-separated)
string
Sub or super city
string
Named area
string
County

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ORBIS_TRAFFIC_FLOW_TILETool 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

integer
required
X coordinate on the zoom grid (0 to 2^z - 1).
integer
required
Y coordinate on the zoom grid (0 to 2^y - 1).
integer
required
Zoom level of the tile to be rendered (0-22).
string
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.
string ("pbf" | "json")
Response format. Note: Only ‘pbf’ (Protocol Buffer binary) is supported. JSON format will return an error.
string
API version, must be ‘1’.
string
Comma-separated list of road categories to filter: motorway, trunk, primary, secondary, tertiary, street, service, track.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ORBIS_TRAFFIC_INCIDENT_DETAILSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ROUTING_BATCHDownload completed asynchronous batch routing results using the batch ID. If processing is still ongoing, the tool raises an error with status 202.

Input Parameters

string
required
Unique batch identifier from the batch submission response’s Location header
integer ("5" | "10" | "15" | "20" | "25" | "30" | "35" | "40" | "45" | "50" | "55" | "60" | "120")
Allowed wait time values for batch processing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_ROUTING_MATRIX_ASYNC_STATUSTool 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

string
required
Unique job identifier returned from the matrix routing submission request. This ID is used to track the status of the asynchronous matrix calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_SATELLITE_TILETool to retrieve satellite imagery map tiles at specified coordinates and zoom. Use when you need high-resolution satellite imagery for mapping applications.

Input Parameters

integer
required
Horizontal tile coordinate, from 0 to 2^zoom - 1.
integer
required
Vertical tile coordinate, from 0 to 2^zoom - 1.
integer
required
Zoom level from 0 (world) to 19 (highest detail).
string
Map style for satellite imagery. Use ‘main’ for primary tile styling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_SNAP_TO_ROADS_BATCH_STATUSTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_TRAFFIC_FLOW_TILES_RASTERTool 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

integer
required
Horizontal tile coordinate in the tile grid (0 to 2^z - 1).
integer
required
Vertical tile coordinate in the tile grid (0 to 2^z - 1).
integer
required
Tile zoom level from 0 (world) to 22 (highest detail).
string ("absolute" | "relative" | "relative0" | "relative0-dark" | "relative-delay" | "reduced-sensitivity")
required
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).
integer ("256" | "512")
Size of the tile in pixels, either 256 or 512. Default is 256 if not specified.
integer
Line thickness for traffic flow visualization (1-20). Default is 10 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_TRAFFIC_INCIDENT_DETAILSTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_TRAFFIC_INCIDENT_TILETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_GET_TRAFFIC_INCIDENT_VIEWPORTTool 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

Determines what copyright information to return (true/false).
string
required
Bounding box of the map viewport in EPSG:900913 projection format (minX,minY,maxX,maxY).
string ("json" | "xml")
required
The content type of the response structure.
string
required
Bounding box of the overview map in EPSG:900913 projection format (minX,minY,maxX,maxY).
integer
required
Zoom level of the map viewport (0-22).
integer
required
Zoom level of the overview map (0-22).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_GEOFENCING_ALERT_RULESTool to list geofencing alert rules with optional filtering. Use when you need to retrieve configured alert rules for projects, fences, or objects.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_GEOFENCING_ALERTS_HISTORYTool to retrieve geofencing alert history within a specified time range. Use when you need to query past alerts triggered by geofencing rules.

Input Parameters

string
required
ISO8601 timestamp indicating the end of the time range (e.g., 2019-08-29T16:00:00).
string
required
ISO8601 timestamp indicating the start of the time range (e.g., 2019-08-29T10:00:00).
string
Type of alert to filter by (e.g., TRANSITION).
integer
Maximum number of results to return per page.
integer
Page number for pagination (starts at 1).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_GEOFENCING_OBJECTSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_LOCATION_HISTORY_OBJECTSTool to list objects with location history. Use when you need to retrieve all objects being tracked for location history.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_NOTIFICATION_GROUPSTool 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

integer
Maximum items returned per page. Range: 1-100. Default: 100.
integer
Page number to return, must be greater than zero. Default: 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_POI_CATEGORIESTool 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

string
IETF language tag for category names (e.g., ‘en-US’, ‘fr-FR’). Defaults to English if not specified or unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_LIST_SPRITE_VERSIONSTool to list available sprite asset versions. Use when you need to know which sprite versions are available after obtaining a valid API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_MAP_DISPLAY_COPYRIGHTSTool to retrieve copyright information for a specific map tile. Use when you need to display or verify attribution for a given tile.

Input Parameters

integer
required
X coordinate of the map tile (non-negative).
integer
required
Y coordinate of the map tile (non-negative).
integer
required
Map zoom level (non-negative).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_MAP_DISPLAY_RASTER_TILETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_MAP_DISPLAY_STATIC_IMAGETool to fetch a static map snapshot given center coords and zoom. Use when you need a standalone map image for display.

Input Parameters

string
Bounding box ‘min_lon,min_lat,max_lon,max_lat’. Required if ‘center’ is not provided. Mutually exclusive with ‘center’ parameter.
string
Map view parameter, e.g., ‘Unified’, ‘Auto’, ‘AR’.
integer
Zoom level between 0 (world) and 20 (max detail). Default: 12.
string ("basic" | "hybrid" | "labels")
Map layer type.
string ("main" | "night")
Map style.
integer
Image width in pixels (1-8192).
string
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.
string ("png" | "jpg")
Output image format.
integer
Image height in pixels (1-8192).
string
Overlay markers; format ‘color|label|lat,lon;color|label|lat,lon’.
string
Language code for map labels, e.g., ‘en-US’.
integer ("256" | "512")
Tile size in pixels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_MAP_DISPLAY_WMS_GET_MAPTool to retrieve a map image via WMS GetMap. Use when you need georeferenced map layers for custom rendering.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_MATRIX_ROUTINGTool 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

object
Optional routing and vehicle profile settings
array
required
List of origin coordinates (must contain at least one origin)
array
required
List of destination coordinates (must contain at least one destination)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_NEARBY_SEARCHTool to find Points of Interest near a specified location. Use after confirming coordinates to discover nearby POIs.

Input Parameters

number
required
Latitude of the center point for the search
number
required
Longitude of the center point for the search
integer
Maximum number of results to return (default: 10, max: 100)
integer
Search radius in meters (default: 10000, max: 50000)
string
Comma-separated list of brand IDs to restrict the results
string
Comma-separated list of country codes to restrict results
integer
Minimum power in kW for charging stations
string
Comma-separated list of category IDs to restrict the search
string
Comma-separated list of connector IDs for charging stations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_PATCH_NOTIFICATIONS_GROUPS_GROUPIDTool 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

string
New name for the contact group
array
List of email addresses for notifications (max 20)
string
required
UUID of the contact group to update
array
List of webhook URLs for message delivery (max 20)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_POINTS_OF_INTEREST_SEARCHTool to search for points of interest by query. Use when you need POI suggestions by name or category.

Input Parameters

number
Latitude for location bias
number
Longitude for location bias
integer
Starting offset for returned results
string
Restrict results to specified map view region
integer
Maximum number of results to return
string
required
Search term, category, or brand name
string
Comma-separated list of indices to include (POI, Geography)
integer
Radius in meters for search area
string
Comma-separated fuel types
string
Comma-separated list of brand names
string
Language tag for result labels (e.g., ‘en-US’, ‘fr-FR’, ‘de-DE’)
boolean
Output local time for opening hours
boolean
Return incomplete results as users type
string
Comma-separated ISO 3166-1 alpha-2 country codes for restricting search
string
Restrict search to specific entity type
string
Comma-separated list of category IDs
Return related POIs (e.g., ‘child’, ‘all’)
string
Categories to bias in result ranking
string
Comma-separated EV connector types
string
Filter POIs by opening hours (e.g., ‘nextSevenDays’)
integer
Maximum typo-correction level
integer
Minimum typo-correction level

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_REVERSE_GEOCODETool to convert geographic coordinates into a human-readable address. Use when you need to obtain address information from latitude and longitude values.

Input Parameters

number
required
Latitude in decimal degrees.
number
required
Longitude in decimal degrees.
string
Street number for more precise results.
integer
Search radius in meters (default: 100).
string
Language for the results, e.g., ‘en-US’.
string
Restrict results to a specific entity type, e.g., ‘CountrySubdivision’.
boolean
Include road use information (true or false).
boolean
Include speed limit information (true or false).
boolean
Allow or disallow newlines in freeform address output.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_REVERSE_GEOCODE_CROSS_STREETTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_REVERSE_GEOCODE_ORBISTool 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

string
Geopolitical view context for the response. Valid values include ‘Unified’, ‘AR’ (Argentina), ‘MA’ (Morocco), ‘IL’ (Israel).
integer
Maximum search distance in meters from the specified position (default: 10000).
number
Vehicle directional heading in degrees. Valid values range from -360 to 360. Used to determine the direction of travel for road matching.
string
Response language using IETF BCP 47 language tags (e.g., ‘en-US’, ‘nl-NL’). Default is NGT (Neutral Ground Truth).
string
required
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.
string
Filter results by specific geography entity types (e.g., ‘Country’, ‘Municipality’, ‘PostalCodeArea’, ‘CountrySubdivision’).
boolean
Include match type information in the response to indicate how the position was matched to the result.
string
Enable road classification information in the response. Use ‘Functional’ to include functional road class data.
boolean
Include posted speed limit information in the response where available (default: false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SEARCH_ALONG_ROUTETool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SEARCH_ALONG_ROUTE_V2Tool 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

string
Geopolitical view context
integer
Maximum number of results to return (1-20, default: 10)
string
required
Search query for POI (e.g., ‘pizza’, ‘gas station’, ‘hotel’)
object
required
Route definition with at least 2 coordinate points to search along
string
Sort results by: ‘detourTime’, ‘detourDistance’, or ‘detourOffset’
string
Comma-separated list of fuel types
string
Comma-separated list of brand names to restrict results
string
IETF language tag for response language
string
Include mapcode formats: ‘Local’, ‘International’, ‘Alternative’
string
Include timezone information (e.g., ‘iana’)
number
Maximum power in kW for EV charging stations
number
Minimum power in kW for EV charging stations
string
Comma-separated list of category IDs to restrict the search
string
Comma-separated list of EV connector types
boolean
Calculate distance from route start point (default: false)
string
Include opening hours information (e.g., ‘nextSevenDays’)
integer
required
Maximum detour time in seconds (0-3600)
string
Comma-separated vehicle types (Car, Truck)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SEARCH_GEOMETRYTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SEARCH_ORBIS_CATEGORYTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SEARCH_ORBIS_PLACESTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SEARCH_ORBIS_POITool 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

number
Latitude for coordinate biasing
number
Longitude for coordinate biasing
integer
Maximum results (default 10, max 100)
string
required
Search term, category, or brand name
integer
Search radius in meters
boolean
Enables predictive mode, default false
string
Service version, currently 1
string
Comma-separated ISO country codes
string
POI category IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_SNAP_TO_ROADS_SYNCTool 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_STRUCTURED_GEOCODETool to convert structured address fields into coordinates. Use after collecting street, city, and postal code.

Input Parameters

string
required
Your TomTom API Key
number
Latitude to bias results
number
Longitude to bias results
string
City name
string
Map view for biasing results, e.g., ‘Unified’, ‘EU’, ‘IN’
integer
Maximum number of results to return (1–100)
integer
Radius in meters to bias results around lat/lon
string
IETF BCP 47 language tag for response
string
Postal code
string
Street name
string
required
Country ISO 3166-1 alpha-2 code (required)
string
Administrative municipality
string
Street number
string
Complete address as free-form string. Overrides structured fields.
string
State, province, or region

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_TRAFFIC_INCIDENTSTool to retrieve detailed traffic incidents within a bounding box. Use when you need incident details for a defined map area.

Input Parameters

string
Comma-separated incident fields to include, e.g., ‘id,geometry,properties’.
string ("json" | "xml")
Response format.
number
required
Maximum latitude (northeast) of bounding box.
number
required
Maximum longitude (northeast) of bounding box.
number
required
Minimum latitude (southwest) of bounding box.
number
required
Minimum longitude (southwest) of bounding box.
string
Language code for the response.
string
Map projection for geometry coordinates.
boolean
Whether to include original position of incidents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_UPDATE_GEOFENCING_SECRETChange the customer secret for the TomTom Geofencing API using the current and new secrets. The secret is used to regenerate a lost or stolen Admin Key.

Input Parameters

string
required
The current/old secret value that needs to be replaced
string
required
The new secret value to be set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: TOMTOM_UPDATE_NOTIFICATIONS_GROUPTool 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

string
Name of the contact group
array
List of email addresses for notifications (max 20)
string
required
UUID of the contact group to update
array
List of webhook URLs for message delivery (max 20)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not