The TomTom connector lets your AI agent act in each user's TomTom account. Each user connects their own TomTom API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 19 tools.
- Tools
- 19
- What they doRead · write · destructive
- 19 · 0 · 019 read0 write0 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the TomTom connection
In AgentKit > Connections, create a TomTom connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'tomtom'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize TomTom:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'tomtom_poi_categories_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "tomtom"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize TomTom:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="tomtom_poi_categories_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their TomTom credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooltomtom_additional_data_getGet the outline geometry (GeoJSON polygons) of geographic areas such as cities or countries, using the geometry IDs returned in search results' dataSources.Read-onlyGet Area Geometry
Get the outline geometry (GeoJSON polygons) of geographic areas such as cities or countries, using the geometry IDs returned in search results' dataSources. Returns a GeoJSON geometry per ID. Use this to draw or test against an area's boundary.
Inputs
geometriesstringrequired- Comma-separated geometry IDs from a search result's dataSources.geometry.id (up to 20). Example: 00004631-3400-3c00-0000-0000673c4d2e.
geometries_zoominteger- Zoom level (0 to 22) that sets the geometry precision. One of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22. Example: 10.
tomtom_autocompleteRecognise what a partial search query means: which parts are a brand, a category or plain text, with suggested categories and brands.Read-onlyAutocomplete Search Query
Recognise what a partial search query means: which parts are a brand, a category or plain text, with suggested categories and brands. Returns segments with their type, matched value and IDs. Use this to build search-as-you-type experiences before calling tomtom_category_search or tomtom_poi_search.
Inputs
languagestringrequired- IETF language tag of the query, e.g. en-US. Example: en-US.
querystringrequired- Partial query typed by the user, e.g. piz. Do not include slashes. Example: pizza.
country_setstring- Comma-separated ISO country codes to restrict results to. Example: NL,BE.
latnumber- Latitude to bias results to; use with lon. Example: 52.3759.
limitinteger- Maximum number of results (default 5, max 10). Example: 5.
lonnumber- Longitude to bias results to; use with lat. Example: 4.8975.
radiusinteger- Radius in meters around lat/lon (up to 5000000). Example: 5000.
result_setstring- Segment types to return: category, brand or category,brand. Example: category,brand.
tomtom_calculate_reachable_rangeCalculate the area reachable from an origin within a time, distance, fuel or energy budget (an isochrone or isodistance).Read-onlyCalculate Reachable Range
Calculate the area reachable from an origin within a time, distance, fuel or energy budget (an isochrone or isodistance). Returns the center and the boundary polygon points. Use this for coverage or delivery-area questions. Set exactly one budget.
Inputs
originstringrequired- Origin as lat,lon, e.g. 52.3759,4.8975. Example: 52.3759,4.8975.
avoidstring- Things to avoid: tollRoads, motorways, ferries, unpavedRoads, carpools, alreadyUsedRoads or borderCrossings. Example: tollRoads.
depart_atstring- Departure time: now or an ISO 8601 date-time (e.g. 2026-07-01T08:00:00). Cannot be used with arrive_at. Defaults to now. Example: now.
energy_budget_ink_whnumber- Energy budget in kWh (electric vehicles). Example: 20.
fuel_budget_in_litersnumber- Fuel budget in liters (combustion vehicles). Example: 10.
hillinessstring- Degree of hilliness for calculating a thrilling route. One of: low, normal, high. Defaults to normal. Example: low.one of
lownormalhigh route_typestring- The type of route requested. One of: fastest, shortest, eco, thrilling. Defaults to fastest. Example: fastest.one of
fastestshortestecothrilling time_budget_in_secnumber- Time budget in seconds. Example: 1800.
trafficboolean- Set to false to ignore live traffic. Defaults to true. Example: true.
travel_modestring- The mode of travel for the requested route. One of: car, truck, taxi, bus, van, motorcycle, bicycle, pedestrian. Defaults to car. Example: car.one of
cartrucktaxibusvanmotorcyclebicyclepedestrian vehicle_engine_typestring- Engine type of the vehicle. One of: combustion, electric. Defaults to combustion. Example: combustion.one of
combustionelectric vehicle_max_speedinteger- Maximum speed of the vehicle in km/hour. Defaults to 0. Example: 90.
vehicle_weightinteger- Weight of the vehicle in kilograms. Defaults to 0. Example: 3500.
windingnessstring- Amount that a thrilling route should wind. One of: low, normal, high. Defaults to normal. Example: low.one of
lownormalhigh
tomtom_calculate_routeCalculate a route between two or more locations for a car, truck, bike, pedestrian or other travel mode, with live traffic, departure or arrival time, things to avoid and vehicle dimensions.Read-onlyCalculate Route
Calculate a route between two or more locations for a car, truck, bike, pedestrian or other travel mode, with live traffic, departure or arrival time, things to avoid and vehicle dimensions. Returns per route the length, travel time, traffic delay, arrival time, legs with points (the polyline), sections and optional turn-by-turn guidance. Use this for directions and ETAs. Use tomtom_matrix_calculate for many origin-destination pairs.
Inputs
locationsstringrequired- Colon-separated lat,lon points from origin through waypoints to destination, e.g. 52.3759,4.8975:52.0907,5.1214. Example: 52.3759,4.8975:52.0907,5.1214.
arrive_atstring- Arrival time as an ISO 8601 date-time. Cannot be used with depart_at. Example: 2026-07-01T09:00:00.
avoidstring- Things to avoid: tollRoads, motorways, ferries, unpavedRoads, carpools, alreadyUsedRoads or borderCrossings. Example: tollRoads.
compute_best_orderboolean- Re-order the route waypoints to reduce the route length. Defaults to false. Example: true.
compute_travel_time_forstring- Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time. One of: none, all. Example: none.one of
noneall depart_atstring- Departure time: now or an ISO 8601 date-time (e.g. 2026-07-01T08:00:00). Cannot be used with arrive_at. Defaults to now. Example: now.
hillinessstring- Degree of hilliness for calculating a thrilling route. One of: low, normal, high. Defaults to normal. Example: low.one of
lownormalhigh instructions_typestring- If specified, guidance instructions will be returned (if available). One of: coded, text, tagged. Example: coded.one of
codedtexttagged languagestring- IETF language tag for the results, e.g. en-US. Defaults to en-GB. Example: en-US.
max_alternativesinteger- Number of alternative routes to be calculated. Defaults to 0. Example: 1.
route_representationstring- Specifies the representation of the set of routes provided as a response. One of: polyline, none. Defaults to polyline. Example: polyline.one of
polylinenone route_typestring- The type of route requested. One of: fastest, shortest, eco, thrilling. Defaults to fastest. Example: fastest.one of
fastestshortestecothrilling section_typestring- Section types to report, e.g. traffic, toll, tunnel, motorway, pedestrian. Defaults to travelMode. Example: traffic.
trafficboolean- Set to false to ignore live traffic. Defaults to true. Example: true.
travel_modestring- The mode of travel for the requested route. One of: car, truck, taxi, bus, van, motorcycle, bicycle, pedestrian. Defaults to car. Example: car.one of
cartrucktaxibusvanmotorcyclebicyclepedestrian vehicle_axle_weightinteger- Weight per axle of the vehicle in kg. Defaults to 0. Example: 1500.
vehicle_commercialboolean- Indicates that the vehicle is used for commercial purposes. This means it may not be allowed on certain roads. Defaults to false. Example: true.
vehicle_engine_typestring- Engine type of the vehicle. One of: combustion, electric. Defaults to combustion. Example: combustion.one of
combustionelectric vehicle_heightnumber- Height of the vehicle in meters. Defaults to 0. Example: 3.1.
vehicle_lengthnumber- Length of the vehicle in meters. Defaults to 0. Example: 6.5.
vehicle_load_typestring- Indicates what kinds of hazardous materials the vehicle is carrying (if any). This means it may not be allowed on certain roads. Use these for routing in the US: - <i>USHazmatClass1</i> Explosives - <i>USHazmatClass2</i> Compressed gas - <i>USHazmatClass3</i> Flammable liquids - <i>USHazmatClass4</i> Flammable solids - <i>USHazmatClass5</i> Oxidizers - <i>USHazmatClass6</i> Poisons - <i>USHazmatClass7</i> Radioactive - <i>USHazmatClass8</i> Corrosives - <i>USHazmatClass9</i> Miscellaneous Use these for routing in all other countries: - <i>otherHazmatExplosive</i> Explosives - <i>otherHazmatGeneral</i> Miscellaneous - <i>otherHazmatHarmfulToWater</i> Harmful to water vehicleLoadType can be specified multiple times. This parameter is currently only considered for <b>travelMode</b>=<i>truck</i>. Example: otherHazmatGeneral.
vehicle_max_speedinteger- Maximum speed of the vehicle in km/hour. Defaults to 0. Example: 90.
vehicle_weightinteger- Weight of the vehicle in kilograms. Defaults to 0. Example: 3500.
vehicle_widthnumber- Width of the vehicle in meters. Defaults to 0. Example: 2.2.
windingnessstring- Amount that a thrilling route should wind. One of: low, normal, high. Defaults to normal. Example: low.one of
lownormalhigh
tomtom_category_searchSearch points of interest of a category such as restaurant, parking or petrol station, optionally near a position or in an area.Read-onlySearch POIs by Category
Search points of interest of a category such as restaurant, parking or petrol station, optionally near a position or in an area. Returns POIs with name, categories, address, position and distance. Use tomtom_poi_categories_list for the category names.
Inputs
querystringrequired- Category name, e.g. restaurant, parking garage or electric vehicle station. Example: restaurant.
btm_rightstring- Bottom-right corner of the bounding box, as lat,lon. Example: 52.33,4.95.
country_setstring- Comma-separated ISO 3166 country codes to restrict results to. Example: NL,BE.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
latnumber- Latitude of the point to bias or center results on, in decimal degrees; use with lon. Example: 52.3759.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
lonnumber- Longitude of the point to bias or center results on, in decimal degrees; use with lat. Example: 4.8975.
ofsinteger- Offset of the first result, for paging. Defaults to 0. Example: 0.
radiusinteger- Radius in meters around lat/lon to restrict results to. Example: 5000.
top_leftstring- Top-left corner of a bounding box to restrict results to, as lat,lon. Example: 52.41,4.84.
typeaheadboolean- Set to true to treat the query as a partial input (search-as-you-type). Defaults to false. Example: false.
viewstring- Geopolitical view for disputed areas. One of: Unified, IN, PK, IL, MA. Defaults to Unified. Example: Unified.one of
UnifiedINPKILMA
tomtom_cross_street_lookupFind the nearest intersection (cross street) to a coordinate.Read-onlyFind Nearest Cross Street
Find the nearest intersection (cross street) to a coordinate. Returns the crossing street names and the intersection position. Use this to describe a location by its nearest intersection.
Inputs
latnumberrequired- Latitude of the position, in decimal degrees. Example: 52.3759.
lonnumberrequired- Longitude of the position, in decimal degrees. Example: 4.8975.
headingnumber- Direction of travel in degrees (0 = north). Example: 90.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
limitinteger- Maximum number of results to return (up to 100). Defaults to 1. Example: 10.
radiusinteger- Maximum distance in meters to look for an intersection. Defaults to 10000. Example: 5000.
spatial_keysboolean- If the "spatialKeys" flag is set, the response will also contain a proprietary geospatial keys for a specified location. Defaults to false. Example: false.
tomtom_fuzzy_searchSearch for addresses, places and points of interest with one free-text query that tolerates typos and partial input, optionally biased to a position or limited to a radius, bounding box or countries.Read-onlySearch Places and Addresses
Search for addresses, places and points of interest with one free-text query that tolerates typos and partial input, optionally biased to a position or limited to a radius, bounding box or countries. Returns ranked results with type, name, address, position, categories, phone and URL for POIs, and a match score. Use this when the query could be anything. Use tomtom_geocode for addresses only and tomtom_poi_search for businesses only.
Inputs
querystringrequired- Free-text query, such as a place name, address or POI type. Do not include slashes (/), ? or #. Example: pizza.
btm_rightstring- Bottom-right corner of the bounding box, as lat,lon. Example: 52.33,4.95.
country_setstring- Comma-separated ISO 3166 country codes to restrict results to. Example: NL,BE.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
idx_setstring- Comma-separated indexes to search: Geo, PAD (point addresses), Addr, Str, XStr, POI. Example: POI,PAD.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
latnumber- Latitude of the point to bias or center results on, in decimal degrees; use with lon. Example: 52.3759.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
lonnumber- Longitude of the point to bias or center results on, in decimal degrees; use with lat. Example: 4.8975.
max_fuzzy_levelinteger- Maximum fuzziness level to be used. Defaults to 2. Example: 2.
min_fuzzy_levelinteger- Minimum fuzziness level to be used. Defaults to 1. Example: 1.
ofsinteger- Offset of the first result, for paging. Defaults to 0. Example: 0.
radiusinteger- Radius in meters around lat/lon to restrict results to. Example: 5000.
top_leftstring- Top-left corner of a bounding box to restrict results to, as lat,lon. Example: 52.41,4.84.
typeaheadboolean- Set to true to treat the query as a partial input (search-as-you-type). Defaults to false. Example: false.
viewstring- Geopolitical view for disputed areas. One of: Unified, IN, PK, IL, MA. Defaults to Unified. Example: Unified.one of
UnifiedINPKILMA
tomtom_geocodeConvert a free-text address or place name into coordinates.Read-onlyGeocode Address
Convert a free-text address or place name into coordinates. Returns matches with the full address, position, entry points, bounding box and score. Use this when you have a written address. Use tomtom_structured_geocode when the address is already split into fields.
Inputs
querystringrequired- Address or place to geocode, e.g. Damrak 1 Amsterdam. Do not include slashes. Example: Damrak 1 Amsterdam.
btm_rightstring- Bottom-right corner of the bounding box, as lat,lon. Example: 52.33,4.95.
country_setstring- Comma-separated ISO 3166 country codes to restrict results to. Example: NL,BE.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
latnumber- Latitude of the point to bias or center results on, in decimal degrees; use with lon. Example: 52.3759.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
lonnumber- Longitude of the point to bias or center results on, in decimal degrees; use with lat. Example: 4.8975.
ofsinteger- Offset of the first result, for paging. Defaults to 0. Example: 0.
radiusinteger- Radius in meters around lat/lon to restrict results to. Example: 5000.
top_leftstring- Top-left corner of a bounding box to restrict results to, as lat,lon. Example: 52.41,4.84.
typeaheadboolean- Set to true to treat the query as a partial input (search-as-you-type). Defaults to false. Example: false.
viewstring- Geopolitical view for disputed areas. One of: Unified, IN, PK, IL, MA. Defaults to Unified. Example: Unified.one of
UnifiedINPKILMA
tomtom_geometry_searchSearch places and POIs inside one or more circles or polygons you define.Read-onlySearch Within Geometry
Search places and POIs inside one or more circles or polygons you define. Returns results with name, address, position and categories. Use this for searches inside a custom area such as a delivery zone.
Inputs
querystringrequired- Free-text query, such as a place name, address or POI type. Do not include slashes (/), ? or #. Example: pizza.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
geometry_listarray- Shapes to search inside: circles {"type": "CIRCLE", "position": "lat, lon", "radius": meters} or polygons {"type": "POLYGON", "vertices": ["lat, lon", ...]}. Example: [{"type":"CIRCLE","position":"52.3759, 4.8975","radius":1000}]
idx_setstring- Comma-separated indexes to search: Geo, PAD (point addresses), Addr, Str, XStr, POI. Example: POI,PAD.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
tomtom_matrix_calculateCalculate travel times and distances between every origin and every destination (up to 100 x 100 cells, within a 400 km box unless the options allow unlimited) in one synchronous call.Read-onlyCalculate Route Matrix
Calculate travel times and distances between every origin and every destination (up to 100 x 100 cells, within a 400 km box unless the options allow unlimited) in one synchronous call. Returns a cell per origin-destination pair with travel time, length, traffic delay and departure and arrival times. Use this to compare many pairs, e.g. nearest driver. Use tomtom_calculate_route for the route itself.
Inputs
destinationsarrayrequired- Destinations, each {"point": {"latitude": ..., "longitude": ...}}. Example: [{"point":{"latitude":52.0907,"longitude":5.1214}},{"point":{"latitude":51.9244,"longitude":4.4777}}]
originsarrayrequired- Origins, each {"point": {"latitude": ..., "longitude": ...}}. Example: [{"point":{"latitude":52.3759,"longitude":4.8975}}]
arrive_atstring- Arrival: any or a future ISO 8601 date-time. Cannot be used with depart_at. Example: 2026-07-01T09:00:00Z.
avoidarray- Things to avoid: tollRoads, unpavedRoads. Example: ["tollRoads"]
depart_atstring- Departure: any, now or a future ISO 8601 date-time. Cannot be used with arrive_at. Example: now.
trafficstring- historical (default) or live traffic. Example: live.one of
historicallive travel_modestring- car (default), truck or pedestrian. Example: car.one of
cartruckpedestrian vehicle_commercialboolean- Set to true for a commercial vehicle. Example: false.
tomtom_nearby_searchList points of interest around a position, nearest first, within an optional radius.Read-onlySearch Nearby POIs
List points of interest around a position, nearest first, within an optional radius. Returns POIs with name, categories, address, position and distance. Use this for what is around a location. Use tomtom_category_search to restrict to one category.
Inputs
latnumberrequired- Latitude of the center point. Example: 52.3759.
lonnumberrequired- Longitude of the center point. Example: 4.8975.
btm_rightstring- Bottom-right corner of the bounding box, as lat,lon. Example: 52.33,4.95.
country_setstring- Comma-separated ISO 3166 country codes to restrict results to. Example: NL,BE.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
idx_setstring- Comma-separated indexes to search: Geo, PAD (point addresses), Addr, Str, XStr, POI. Example: POI,PAD.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
max_fuzzy_levelinteger- Maximum fuzziness level to be used. Defaults to 2. Example: 2.
min_fuzzy_levelinteger- Minimum fuzziness level to be used. Defaults to 1. Example: 1.
ofsinteger- Offset of the first result, for paging. Defaults to 0. Example: 0.
radiusinteger- Search radius in meters (default 10000). Example: 5000.
top_leftstring- Top-left corner of a bounding box to restrict results to, as lat,lon. Example: 52.41,4.84.
viewstring- Geopolitical view for disputed areas. One of: Unified, IN, PK, IL, MA. Defaults to Unified. Example: Unified.one of
UnifiedINPKILMA
tomtom_place_getGet the full details of a place by its ID from an earlier search result.Read-onlyGet Place by ID
Get the full details of a place by its ID from an earlier search result. Returns name, address, position, categories, phone, URL, opening hours, time zone and related POIs. Use this to refresh or expand one search result.
Inputs
entity_idstringrequired- ID of the place (the id of a search result). Example: 528009004256119.
languagestring- IETF language tag for the result, e.g. en-US. Example: en-US.
opening_hoursstring- Set to nextSevenDays to include opening hours. Example: nextSevenDays.one of
nextSevenDays related_poisstring- Related POIs to include: off, child, parent or all. Example: all.one of
offchildparentall time_zonestring- Set to iana to include the place's time zone. Example: iana.one of
iana viewstring- Geopolitical view for disputed areas. Example: Unified.
tomtom_poi_categories_listList the full tree of point-of-interest categories with their IDs, names, synonyms and child categories.Read-onlyList POI Categories
List the full tree of point-of-interest categories with their IDs, names, synonyms and child categories. Use this to find category names or IDs for tomtom_category_search.
Inputs
languagestring- IETF language tag for category names, e.g. en-US. Example: en-US.
tomtom_poi_searchSearch points of interest (businesses and landmarks) by name, brand or type, optionally near a position or in an area.Read-onlySearch Points of Interest
Search points of interest (businesses and landmarks) by name, brand or type, optionally near a position or in an area. Returns POIs with name, categories, brand, address, position, phone, URL and distance. Use this for businesses. Use tomtom_category_search to search by category name and tomtom_nearby_search for everything around a point.
Inputs
querystringrequired- POI name or type to search for, e.g. Starbucks or museum. Do not include slashes. Example: pizza.
btm_rightstring- Bottom-right corner of the bounding box, as lat,lon. Example: 52.33,4.95.
country_setstring- Comma-separated ISO 3166 country codes to restrict results to. Example: NL,BE.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
latnumber- Latitude of the point to bias or center results on, in decimal degrees; use with lon. Example: 52.3759.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
lonnumber- Longitude of the point to bias or center results on, in decimal degrees; use with lat. Example: 4.8975.
ofsinteger- Offset of the first result, for paging. Defaults to 0. Example: 0.
radiusinteger- Radius in meters around lat/lon to restrict results to. Example: 5000.
top_leftstring- Top-left corner of a bounding box to restrict results to, as lat,lon. Example: 52.41,4.84.
typeaheadboolean- Set to true to treat the query as a partial input (search-as-you-type). Defaults to false. Example: false.
viewstring- Geopolitical view for disputed areas. One of: Unified, IN, PK, IL, MA. Defaults to Unified. Example: Unified.one of
UnifiedINPKILMA
tomtom_reverse_geocodeConvert coordinates into the nearest address, optionally with the street's speed limit and road use.Read-onlyReverse Geocode
Convert coordinates into the nearest address, optionally with the street's speed limit and road use. Returns the address (street, number, postal code, city, country) and the matched position. Use this to describe where a coordinate is. Use tomtom_cross_street_lookup for the nearest intersection.
Inputs
latnumberrequired- Latitude of the position, in decimal degrees. Example: 52.3759.
lonnumberrequired- Longitude of the position, in decimal degrees. Example: 4.8975.
headingnumber- Direction of travel in degrees (0 = north), to pick the right side of the road. Example: 90.
numberstring- House number to look for on the matched street. Example: 1.
radiusinteger- Maximum distance in meters from the position to look for an address. Defaults to 10000. Example: 5000.
return_road_useboolean- Enables return of the road use array for reverse geocodes at street level. Defaults to false. Example: true.
return_speed_limitboolean- To enable return of the posted speed limit (where available). Defaults to false. Example: true.
road_usestring- Road uses to restrict the match to, e.g. LocalStreet, Arterial, Ramp, Rotary. Example: LocalStreet.
spatial_keysboolean- If the "spatialKeys" flag is set, the response will also contain a proprietary geospatial keys for a specified location. Defaults to false. Example: false.
tomtom_search_along_routeSearch POIs along a route given as a list of points, within a maximum detour time.Read-onlySearch Along Route
Search POIs along a route given as a list of points, within a maximum detour time. Returns POIs with name, address, position and the detour time and distance. Use this to find fuel, charging or food stops on a trip; get the route points from tomtom_calculate_route.
Inputs
max_detour_timeintegerrequired- Maximum detour in seconds for a stop (up to 3600). Example: 600.
querystringrequired- POI name or type, e.g. petrol station. Do not include slashes. Example: petrol station.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
routeobject- Route as {"points": [{"lat": ..., "lon": ...}, ...]} with at least 2 points. Example: {"points":[{"lat":52.3759,"lon":4.8975},{"lat":52.0907,"lon":5.1214}]}
tomtom_structured_geocodeConvert an address given as separate fields (country code, street, number, postal code, city and so on) into coordinates.Read-onlyGeocode Structured Address
Convert an address given as separate fields (country code, street, number, postal code, city and so on) into coordinates. Returns matches with the full address, position and score. Use this when your address data is already structured.
Inputs
country_codestringrequired- 2 or 3 letter country code (e.g.: FR, ES). Example: NL.
country_secondary_subdivisionstring- The county for the structured address. Example: Amsterdam.
country_subdivisionstring- The state or province for the structured address. Example: Noord-Holland.
country_tertiary_subdivisionstring- The named area for the structured address. Example: Amsterdam.
cross_streetstring- The cross street name for the structured address. Example: Nieuwendijk.
extended_postal_codes_forstring- Indexes for which extended postal codes should be included in the results. Available indexes are: - <b>Addr</b> = Address ranges - <b>Geo</b> = Geographies - <b>PAD</b> = Point Addresses - <b>POI</b> = Points of Interest - <b>Str</b> = Streets - <b>XStr</b> = Cross Streets (intersections). Example: PAD,Addr.
languagestring- IETF language tag for the results, e.g. en-US. Example: en-US.
limitinteger- Maximum number of results to return (up to 100). Defaults to 10. Example: 10.
municipalitystring- The municipality (city/town) for the structured address. Example: Amsterdam.
municipality_subdivisionstring- The municipality subdivision (sub/super city) for the structured address. Example: Centrum.
ofsinteger- Offset of the first result, for paging. Defaults to 0. Example: 0.
postal_codestring- The zip code or postal code for the structured address. Example: 1012.
street_namestring- The street name for the structured address. Example: Damrak.
street_numberstring- The street number for the structured address. Example: 1.
tomtom_traffic_flow_segment_getGet live traffic on the road segment closest to a point.Read-onlyGet Traffic Flow
Get live traffic on the road segment closest to a point. Returns current and free-flow speed and travel time, confidence, whether the road is closed, and the segment's coordinates. Use this to check congestion at a location.
Inputs
pointstringrequired- Point as lat,lon, e.g. 52.3759,4.8975. Example: 52.3759,4.8975.
stylestringrequired- Flow style that sets how speeds are classified: absolute, relative, relative0, relative0-dark, relative-delay or reduced-sensitivity. Example: relative0.one of
absoluterelativerelative0relative0-darkrelative-delayreduced-sensitivity zoomintegerrequired- Map zoom level (0 to 22) that sets how coarse the road network is. Example: 10.
open_lrboolean- Set to true to include the OpenLR location code. Example: false.
thicknessinteger- Segment line thickness 1 to 20 (affects which segment is matched). Example: 10.
unitstring- Speed unit: KMPH (default) or MPH. Example: KMPH.one of
KMPHMPH
tomtom_traffic_incidents_getGet live traffic incidents (accidents, jams, road works, closures, weather) inside a bounding box of up to 10,000 km², or by incident IDs.Read-onlyGet Traffic Incidents
Get live traffic incidents (accidents, jams, road works, closures, weather) inside a bounding box of up to 10,000 km², or by incident IDs. Returns incidents as GeoJSON features with type, location, delay, length, start and end time and description, depending on the fields selection. Use this to see what is disrupting traffic in an area.
Inputs
bboxstring- Bounding box minLon,minLat,maxLon,maxLat (up to 10,000 km²). Give this or ids. Example: 4.80,52.30,5.00,52.42.
category_filterstring- Comma-separated categories: 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. Example: 1,6,8,9.
fieldsstring- Fields to return, in TomTom's nested selection syntax. Example: {incidents{type,geometry{type,coordinates},properties{id,iconCategory,magnitudeOfDelay,events{description,code},startTime,endTime,from,to,length,delay}}}
idsstring- Comma-separated incident IDs (up to 5). Give this or bbox. Example: 4819f7d0a1ed3a4b4e3c4e8f7f8c3b2a.
languagestring- Language of descriptions, e.g. en-GB (default) or nl-NL. Example: en-GB.
time_validity_filterstring- present (default), future, or present,future. Example: present.
No tools match.