> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/tomtom.md).

# TomTom

Geocode addresses, calculate driving routes, search points of interest, and check live traffic incidents with TomTom's location APIs.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| TomTom    | API Key        |

### TomTom

Connect with a TomTom API key to geocode addresses, calculate routes, search points of interest, and check traffic incidents.

#### Set up in TomTom

1. Prepare the TomTom account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Copy a key from the API & SDK Keys tab of your TomTom Developer Portal dashboard. The key must be enabled for the Search, Routing, and Traffic Incidents APIs to use every TomTom action.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **TomTom**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                 |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Copy a key from the API & SDK Keys tab of your TomTom Developer Portal dashboard. The key must be enabled for the Search, Routing, and Traffic Incidents APIs to use every TomTom action. [Provider instructions](https://developer.tomtom.com/user/me/apps). |

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

## Use an action

1. Add the required **TomTom** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### Geocode Address

Turn a written address or place name into map coordinates.

#### Inputs

| Field              | Type    | Required | Description                                                              |
| ------------------ | ------- | -------- | ------------------------------------------------------------------------ |
| Address            | string  | Yes      | The address or place to look up. More detail gives a better match.       |
| Limit to Countries | string  | No       | Only return matches in these countries. Leave empty to search worldwide. |
| Language           | string  | No       | Language for the returned addresses, such as en-US or fr-FR.             |
| Max Results        | integer | No       | How many candidate matches to return. Default: 5.                        |

#### Outputs

| Field   | Type          | Description                                              |
| ------- | ------------- | -------------------------------------------------------- |
| Results | object\_array | Matching locations with coordinates and address details. |
| Count   | integer       | Number of matches returned.                              |

### Reverse Geocode Coordinates

Turn map coordinates into the nearest street address.

#### Inputs

| Field                  | Type    | Required | Description                                       |
| ---------------------- | ------- | -------- | ------------------------------------------------- |
| Latitude               | number  | Yes      | Latitude of the point, between -90 and 90.        |
| Longitude              | number  | Yes      | Longitude of the point, between -180 and 180.     |
| Search Radius (meters) | integer | No       | How far from the point to look for an address.    |
| Language               | string  | No       | Language for the returned address, such as en-US. |

#### Outputs

| Field   | Type    | Description                                  |
| ------- | ------- | -------------------------------------------- |
| Found   | boolean | Whether an address was found near the point. |
| Address | object  | The nearest address and its parts.           |

### Calculate Route

Get driving directions, distance, and arrival time between two or more places.

#### Inputs

| Field                 | Type                      | Required | Description                                                                                                                                                        |
| --------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Start                 | string                    | Yes      | Where the trip starts: an address or coordinates.                                                                                                                  |
| Destination           | string                    | Yes      | Where the trip ends: an address or coordinates.                                                                                                                    |
| Stops Along the Way   | textarea                  | No       | Places to visit in between, one per line, in order.                                                                                                                |
| Travel Mode           | select (string)           | No       | How you are travelling. Available values: Car, Truck, Van (beta), Taxi (beta), Bus (beta), Motorcycle (beta), Bicycle, Pedestrian. Default: car.                   |
| Show advanced options | boolean                   | No       | Show route preference, roads to avoid, departure time, and directions. Default: false.                                                                             |
| Route Preference      | select (string)           | No       | Optimize for time, distance, fuel use, or scenic roads. Available values: Fastest, Shortest, Eco (fuel efficient), Thrilling (scenic, car only). Default: fastest. |
| Avoid                 | multiple\_select (string) | No       | Road types to stay off, such as tolls or ferries. Available values: Toll roads, Motorways, Ferries, Unpaved roads, Tunnels, Border crossings.                      |
| Departure Time        | datetime                  | No       | Leave later instead of now, to plan around expected traffic.                                                                                                       |
| Include Directions    | boolean                   | No       | Include step-by-step driving directions. Default: true.                                                                                                            |

#### Outputs

| Field                   | Type          | Description                                       |
| ----------------------- | ------------- | ------------------------------------------------- |
| Distance (meters)       | integer       | Total route length.                               |
| Travel Time (seconds)   | integer       | Estimated trip duration including traffic.        |
| Traffic Delay (seconds) | integer       | Extra time caused by current traffic.             |
| Departure Time          | string        | When the trip starts.                             |
| Arrival Time            | string        | Estimated arrival.                                |
| Legs                    | object\_array | Distance and time for each part of the trip.      |
| Directions              | object\_array | Step-by-step directions.                          |
| Resolved Locations      | object\_array | The exact points used for each place you entered. |

### Search Points of Interest

Find nearby places like restaurants, gas stations, or hotels around a location.

#### Inputs

| Field                  | Type                      | Required | Description                                                                         |
| ---------------------- | ------------------------- | -------- | ----------------------------------------------------------------------------------- |
| What to Find           | string                    | Yes      | The kind of place or a name, such as coffee, EV charging, or Starbucks.             |
| Near                   | string                    | Yes      | The area to search around: an address or coordinates.                               |
| Search Radius (meters) | integer                   | No       | How far from the location to search. Default: 5000.                                 |
| Show advanced options  | boolean                   | No       | Show category filters, pagination offset, and language. Default: false.             |
| Categories             | multiple\_select (string) | No       | Only include places in these categories. Options load from the selected connection. |
| Language               | string                    | No       | Language for names and addresses, such as en-US.                                    |
| Max Results            | integer                   | No       | How many places to return. Default: 10.                                             |
| Start After            | integer                   | No       | Skip this many results, to get the next page.                                       |

#### Outputs

| Field         | Type          | Description                                   |
| ------------- | ------------- | --------------------------------------------- |
| Places        | object\_array | Places found, nearest-relevant first.         |
| Count         | integer       | Number of places returned.                    |
| Next Offset   | integer       | Pass this as Start After to get more results. |
| Search Center | object        | The exact point searched around.              |

### Get Traffic Incidents

See current accidents, closures, roadworks, and jams around a location.

#### Inputs

| Field                 | Type                      | Required | Description                                                                                                                                                                              |
| --------------------- | ------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Near                  | string                    | No       | The area to check: an address or coordinates.                                                                                                                                            |
| Radius (km)           | number                    | No       | How far around the location to look, up to 45 km. Default: 10.0.                                                                                                                         |
| Show advanced options | boolean                   | No       | Show bounding box, incident types, planned incidents, and language. Default: false.                                                                                                      |
| Bounding Box          | string                    | No       | An exact map rectangle instead of a location and radius.                                                                                                                                 |
| Incident Types        | multiple\_select (string) | No       | Only include these kinds of incidents. Available values: Accident, Fog, Dangerous conditions, Rain, Ice, Jam, Lane closed, Road closed, Road works, Wind, Flooding, Broken down vehicle. |
| Include Planned       | boolean                   | No       | Also include scheduled future incidents such as planned roadworks. Default: false.                                                                                                       |
| Language              | string                    | No       | Language for incident descriptions, such as en-GB.                                                                                                                                       |
| Max Results           | integer                   | No       | How many incidents to return, most severe first. Default: 50.                                                                                                                            |

#### Outputs

| Field         | Type          | Description                           |
| ------------- | ------------- | ------------------------------------- |
| Incidents     | object\_array | Incidents in the area.                |
| Count         | integer       | Number of incidents returned.         |
| Total in Area | integer       | All incidents found before the limit. |
| Bounding Box  | string        | The exact area searched.              |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/tomtom.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
