Tomtom

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.

Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (19)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

List Map FontsTOMTOM_ASSETS_LIST_FONTSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Assets SpritesTOMTOM_ASSETS_LIST_SPRITESAcción

Tool to list available sprites for a given asset version. use after determining the assetversion.

Parámetros de entrada

keystringObligatorio
A valid TomTom API key.
apiVersionstring
API version of the service. Current value is '1'.
assetVersionstringObligatorio
The chosen version of the asset. Wildcards are supported, e.g., '3.*'.
assetCategoriesstring[]
Optional filter for sprite categories. Possible values: 'map', 'trafficFlow', 'trafficIncidents'.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List map stylesTOMTOM_ASSETS_LIST_STYLESAcción

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

Parámetros de entrada

apiVersionstringObligatorio
The API version of the Orbis Maps service to call. This query parameter takes precedence over any header value.
assetVersionstringObligatorio
The chosen version of the asset (e.g., '1.0' or wildcard '1.*'). See https://developer.tomtom.com/assets-api/documentation/tomtom-orbis-maps/product-information/assets-versioning
assetCategoriesstring[]
Optional list of asset categories to filter by. Provide multiple values to filter on multiple categories, e.g., ['vector','raster'].

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Calculate RouteTOMTOM_CALCULATE_ROUTEAcción

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

Parámetros de entrada

endstringObligatorio
Destination coordinates as 'lat,lon'.
avoidstring
Features to avoid (comma-separated), e.g., 'tollRoads,highways'.
startstringObligatorio
Origin coordinates as 'lat,lon'.
reportstring
Additional report fields, e.g., 'effectiveSettings,travelTimes'.
trafficboolean
Whether to consider live traffic data.
languagestring
Language for instructions and results.
arrive_atstring
Arrival time in ISO 8601 format.
depart_atstring
Departure time in ISO 8601 format.
waypointsstring
Intermediate waypoints as 'lat,lon:lat,lon'.
route_typestringenum
Route calculation strategy.
fastestshortestecothrilling
travel_modestringenum
Mode of transport.
cartrucktaxibusvanmotorcyclebicyclepedestrian
section_typestring
Comma-separated list of section types to include, e.g., 'traffic,toll'.
instructions_typestringenum
Format of guidance instructions.
codedtexttagged

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Category SearchTOMTOM_CATEGORY_SEARCHAcción

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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

EV Charging Stations AvailabilityTOMTOM_EV_CHARGING_STATIONS_AVAILABLEAcción

Tool to retrieve ev charging station availability info. use when you have the connectorsetid and poiid to get live availability.

Parámetros de entrada

poiIDstringObligatorio
POI (charging station) identifier.
operatorIDstring
EVSE operator identifier.
connectorSetIDstringObligatorio
Identifier of an EV connector set.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Flow Segment DataTOMTOM_FLOW_SEGMENT_DATAAcción

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

Parámetros de entrada

unitstringenum
Unit for speed values.
KMPHMPH
zoomintegerObligatorio
Zoom level for the flow segment data (0-22).
pointstringObligatorio
Center point of the segment in 'lat,lon' format.
stylestringObligatorio
Display style of the flow data.
formatstringObligatorioenum
Response format of the data.
jsonxml
openLrboolean
Whether to include OpenLR descriptors in the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Fuzzy SearchTOMTOM_FUZZY_SEARCHAcción

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

Parámetros de entrada

latnumber
Latitude for contextual biasing
lonnumber
Longitude for contextual biasing
ofsinteger
Starting offset for returned results
viewstringenum
Geopolitical view for geography rendering
UnifiedAR
limitinteger
Maximum number of results to return
querystringObligatorio
Free-form search text for address or POI
idxSetstring
Comma-separated index types (e.g., 'PAD,Geo,Addr')
radiusinteger
Bias radius in meters around lat/lon
geobiasstringenum
Enable or disable geobias (default: 'on')
onoff
brandSetstring
Comma-separated brand names to restrict results
languagestring
Response language (e.g., 'en-US')
countrySetstring
Comma-separated country codes to restrict results (e.g., 'US,CA')
minPowerKWinteger
Minimum power (kW) for EV charging stations
boundingBoxstring
Limit to bounding box: 'minLon,minLat,maxLon,maxLat'
categorySetstring
Comma-separated category IDs (e.g., '7315,9362')
relatedPoisstringenum
Return related POIs: 'off', 'child', or 'all'
offchildall
categoryTypestringenum
Restrict to POI or geography categories
POIGeography
connectorSetstring
Comma-separated EV connector types (e.g., 'IEC_62196_T2')
openingHoursstringenum
Filter by opening hours
nextSevenDaysnextLocalDay
entityTypeSetstring
Comma-separated entity types to restrict
politicalViewstring
Political view parameter for geography rendering

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Sprite VersionsTOMTOM_LIST_SPRITE_VERSIONSAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Map CopyrightsTOMTOM_MAP_DISPLAY_COPYRIGHTSAcción

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

Parámetros de entrada

xintegerObligatorio
X coordinate of the map tile (non-negative).
yintegerObligatorio
Y coordinate of the map tile (non-negative).
zoomintegerObligatorio
Map zoom level (non-negative).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

MAP_DISPLAY_RASTER_TILETOMTOM_MAP_DISPLAY_RASTER_TILEAcción

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

Parámetros de entrada

XintegerObligatorio
Tile X coordinate (integer ≥ 0).
YintegerObligatorio
Tile Y coordinate (integer ≥ 0).
viewstring
View parameter, typically 'Unified'.
zoomintegerObligatorio
Zoom level between 0 (world) and 22 (max detail).
layerstringenum
Map layer style.
basichybrid
stylestringenum
Visual theme of the map.
mainnightlabels
formatstringenum
Image format to return.
pngjpg
languagestring
Language code for map labels, e.g., 'en-GB'.
tileSizeintegerenum
Tile size in pixels, either 256 or 512.
256512

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Map Display Static ImageTOMTOM_MAP_DISPLAY_STATIC_IMAGEAcción

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

Parámetros de entrada

bboxstring
Bounding box 'min_lon,min_lat,max_lon,max_lat'.
viewstring
Map view parameter, e.g., 'Unified', 'Auto', 'AR'.
zoomintegerObligatorio
Zoom level between 0 (world) and 22 (max detail).
layerstringenum
Map layer type.
basichybridlabels
stylestringenum
Map style.
mainnight
widthinteger
Image width in pixels (1-2000).
centerstringObligatorio
Coordinates of the map center as 'lat,lon'.
formatstringenum
Output image format.
pngjpg
heightinteger
Image height in pixels (1-2000).
markersstring
Overlay markers; format 'color|label|lat,lon;color|label|lat,lon'.
trafficboolean
Whether to overlay real-time traffic data.
languagestring
Language code for map labels, e.g., 'en-US'.
tileSizeintegerenum
Tile size in pixels.
256512

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Map Display WMS GetMapTOMTOM_MAP_DISPLAY_WMS_GET_MAPAcción

Tool to retrieve a map image via wms getmap. use when you need georeferenced map layers for custom rendering.

Parámetros de entrada

crsstring
Coordinate Reference System for WMS 1.3.0, e.g., 'EPSG:4326'
srsstring
Coordinate Reference System for WMS 1.1.1, e.g., 'EPSG:4326'
bboxstringObligatorio
Bounding box in 'minx,miny,maxx,maxy' format
timestring
Time parameter for time-enabled layers
widthintegerObligatorio
Image width in pixels, must be >= 1
formatstringObligatorio
Image format, e.g., 'image/png' or 'image/jpeg'
heightintegerObligatorio
Image height in pixels, must be >= 1
layersstringObligatorio
Comma-separated list of map layers to display
stylesstring
Comma-separated list of layer styles; empty for default
bgcolorstring
Background color in hex, e.g., '0xFFFFFF'
requeststringObligatorio
Request type, must be 'GetMap'
servicestringObligatorio
Service type, must be 'WMS'
versionstringObligatorioenum
WMS version to use
1.1.11.3.0
elevationstring
Elevation parameter for dimension-enabled layers
exceptionsstring
Exception output format, e.g., 'INIMAGE'
transparentboolean
Transparency flag; TRUE for transparent background

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Matrix RoutingTOMTOM_MATRIX_ROUTINGAcción

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.

Parámetros de entrada

optionsobject
Optional routing and vehicle profile settings
originsobject[]Obligatorio
List of origin coordinates (must contain at least one origin)
destinationsobject[]Obligatorio
List of destination coordinates (must contain at least one destination)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Nearby SearchTOMTOM_NEARBY_SEARCHAcción

Tool to find points of interest near a specified location. use after confirming coordinates to discover nearby pois.

Parámetros de entrada

latnumberObligatorio
Latitude of the center point for the search
lonnumberObligatorio
Longitude of the center point for the search
limitinteger
Maximum number of results to return (default: 10, max: 100)
radiusinteger
Search radius in meters (default: 10000, max: 50000)
brandSetstring
Comma-separated list of brand IDs to restrict the results
countrySetstring
Comma-separated list of country codes to restrict results
minPowerKWinteger
Minimum power in kW for charging stations
categorySetstring
Comma-separated list of category IDs to restrict the search
connectorSetstring
Comma-separated list of connector IDs for charging stations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Points of Interest SearchTOMTOM_POINTS_OF_INTEREST_SEARCHAcción

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

Parámetros de entrada

latnumber
Latitude for location bias
lonnumber
Longitude for location bias
ofsinteger
Starting offset for returned results
viewstring
Restrict results to specified map view region
limitinteger
Maximum number of results to return
querystringObligatorio
Search term, category, or brand name
idxSetstring
Comma-separated list of indices to include (POI, Geography)
radiusinteger
Radius in meters for search area
fuelSetstring
Comma-separated fuel types
brandSetstring
Comma-separated list of brand names
languagestring
ISO 639-1 language code for result labels
timeZoneboolean
Output local time for opening hours
typeaheadboolean
Return incomplete results as users type
countrySetstring
Comma-separated ISO 3166-1 alpha-2 country codes for restricting search
entityTypestring
Restrict search to specific entity type
categorySetstring
Comma-separated list of category IDs
relatedPoisstring
Return related POIs (e.g., 'child', 'all')
categoryBiasstring
Categories to bias in result ranking
connectorSetstring
Comma-separated EV connector types
openingHoursstring
Filter POIs by opening hours (e.g., 'nextSevenDays')
maxFuzzyLevelinteger
Maximum typo-correction level
minFuzzyLevelinteger
Minimum typo-correction level

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Reverse GeocodeTOMTOM_REVERSE_GEOCODEAcción

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

Parámetros de entrada

latnumberObligatorio
Latitude in decimal degrees.
lonnumberObligatorio
Longitude in decimal degrees.
numberstring
Street number for more precise results.
radiusinteger
Search radius in meters (default: 100).
languagestring
Language for the results, e.g., 'en-US'.
entityTypestring
Restrict results to a specific entity type, e.g., 'CountrySubdivision'.
returnRoadUseboolean
Include road use information (true or false).
returnSpeedLimitboolean
Include speed limit information (true or false).
allowFreeformNewlineboolean
Allow or disallow newlines in freeform address output.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Structured GeocodeTOMTOM_STRUCTURED_GEOCODEAcción

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

Parámetros de entrada

keystringObligatorio
Your TomTom API Key
latnumber
Latitude to bias results
lonnumber
Longitude to bias results
citystring
City name
viewstring
Map view for biasing results, e.g., 'Unified', 'EU', 'IN'
limitinteger
Maximum number of results to return (1–100)
radiusinteger
Radius in meters to bias results around lat/lon
languagestring
IETF BCP 47 language tag for response
postalCodestring
Postal code
streetNamestring
Street name
countryCodestring
Country ISO 3166-1 alpha-2 code
municipalitystring
Administrative municipality
streetNumberstring
Street number
freeformAddressstring
Complete address as free-form string. Overrides structured fields.
countrySubdivisionstring
State, province, or region

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Traffic IncidentsTOMTOM_TRAFFIC_INCIDENTSAcción

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

Parámetros de entrada

fieldsstring
Comma-separated incident fields to include, e.g., 'id,geometry,properties'.
formatstringenum
Response format.
jsonxml
max_latnumberObligatorio
Maximum latitude (northeast) of bounding box.
max_lonnumberObligatorio
Maximum longitude (northeast) of bounding box.
min_latnumberObligatorio
Minimum latitude (southwest) of bounding box.
min_lonnumberObligatorio
Minimum longitude (southwest) of bounding box.
languagestring
Language code for the response.
projectionstring
Map projection for geometry coordinates.
original_positionboolean
Whether to include original position of incidents.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not