# Tomtom — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Get TomTom Traffic Index congestion rankings for cities worldwide or within a specific country, and retrieve detailed traffic metrics for a given city (including AM/PM and monthly trends).

**Category:** Maps & Geospatial | **Website:** [tomtom.com/](https://tomtom.com/) | **Docs:** [parse.bot/marketplace/32b3a9de-f69e-4ed3-9cd8-cc74c4d644be/tomtom-com-api](https://parse.bot/marketplace/32b3a9de-f69e-4ed3-9cd8-cc74c4d644be/tomtom-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/tomtom/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get city details

Get detailed traffic information for a specific city including base congestion, AM/PM peak metrics (peak hour and congestion percentage), and monthly trend data for the year. The city key can be obtained from the ranking endpoints.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | Yes | City key in lowercase hyphenated format (e.g. 'london', 'new-york-ny', 'mexico-city', 'belfast'). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/tomtom/get-city-details \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>"}'
```

### Get congestion rankings

Get global city congestion rankings across multiple countries. Returns cities sorted by congestion score (highest first). Each city includes its key, name, country, AM/PM metrics, congestion score, and rank. When no countries are specified, defaults to the first 10 countries alphabetically from the internal list. Fetching many countries is expensive — one HTTP round-trip per country.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `countries` | string | No | Comma-separated list of country keys to include (e.g. 'united-kingdom,mexico,united-states-of-america'). Omitting returns cities from default set of countries. |
| `limit` | integer | No | Maximum number of cities to return in the ranking. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/tomtom/get-congestion-rankings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"countries":"<string>","limit":"<integer>"}'
```

### Get country rankings

Get congestion rankings for cities within a specific country. Returns cities sorted by congestion score (highest first). Each city includes its key, name, AM/PM metrics, congestion score, and rank within the country.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `country` | string | Yes | Country key in lowercase hyphenated format (e.g. 'united-kingdom', 'united-states-of-america', 'mexico', 'france'). |
| `limit` | integer | No | Maximum number of cities to return. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/tomtom/get-country-rankings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"country":"<string>","limit":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.