> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# TomTom plugin

> Search places and addresses, geocode both ways, calculate routes, and read live traffic incidents and flow.

Use **TomTom** through Corsair: one client, typed API calls.

Create an API key in the TomTom developer portal at my.tomtom.com. The key travels as the `key` query parameter on every request, and it must have the Search, Routing or Traffic product enabled for the endpoints you call.

Things to know:

* **Paging is offset based.** `limit` caps at 100 and `offset` skips within the result set; `summary.totalResults` is the total available; `summary.numResults` is the size of this page.
* **A search with no matches is a success.** TomTom answers 200 with an empty `results` array, so check the array rather than the status.
* **`radius` needs a point.** A radius without `lat` and `lon` is rejected before the request, because the API ignores it otherwise.
* **Routes take coordinates, not addresses.** Geocode first, then pass the resulting positions. `origins` and `destinations` each accept several waypoints, joined with colons in the path.
* **Traffic needs a bounding box.** `traffic.incidents` takes `minLon,minLat,maxLon,maxLat` covering at most 10,000 km², such as `4.88,52.36,4.92,52.39` for central Amsterdam. An inverted box is rejected here rather than at the provider.
* **Tiles are images, not JSON.** `traffic.tile` returns `{ content_type, base64 }`: the PNG bytes base64-encoded. Both layers take a style in the path (`style` for flow, `incident_style` for incidents).
* **A 403 is a plan limit.** The key is valid but does not cover the product or the region, so the plugin does not retry it.

**What you get:**

* 7 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/tomtom better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/tomtom better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/tomtom better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/tomtom better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { tomtom } from '@corsair-dev/tomtom';

export const corsair = createCorsair({
	plugins: [
		tomtom(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the TomTom API key before the first call: `pnpm corsair setup --plugin=tomtom --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> tomtom()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. Connect a tenant**

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](https://docs.corsair.dev/management/connect).

```ts theme={null}
const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'tomtom',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl
```

## Example API calls

**Search for a place with a geo bias**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.tomtom.api.search.fuzzy({
	query: 'pizza',
	lat: 52.37,
	lon: 4.89,
	limit: 5,
});
```

**Calculate a route between two points**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.tomtom.api.routing.calculate({
	origins: [{ latitude: 52.37, longitude: 4.89 }],
	destinations: [{ latitude: 52.09, longitude: 5.12 }],
	traffic: true,
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/tomtom/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/tomtom/api.md)
>
> Every `tomtom.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.