This is the documentation of version 1.0.0-rc.3. Go to the latest version, 1.0.0-rc.5.

What the SDK sends, and where

This page lists the data the SDK sends from your users' browsers, and where it goes, for your privacy notice and your records of processing (GDPR Articles 13 and 30).

In short, the SDK talks to api.tomtom.com, or to your proxy, and sends only what each map view and service call needs.

What the SDK does not do

What goes to api.tomtom.com

When the browser calls TomTom directly, every request reaches TomTom with the user's IP address, as any HTTP request does. In proxy mode, the same data passes through your proxy first, which changes the address TomTom sees. TomTom also receives:

When What TomTom receives
Every map view The style document, then the tiles, sprites and glyphs for the area on screen. Tile coordinates (z/x/y) show roughly which area the user is looking at.
Search, geocoding and autocomplete The query text, any position or area you bias the results with, and the area of a geometry search or the route of an along-route search
Reverse geocoding The position, and the heading if you pass one
Routing and reachable range The origin, destination and waypoints, plus the vehicle parameters you set: weight, heading and restrictions such as a maximum speed
Traffic incident details The bounding box or incident IDs
Traffic area analytics The area's geometry, and the dates, hours and road classes you ask for
Place details, geometry data The place or geometry IDs
Every service call, and every map request except images A tomtom-user-agent header holding the SDK name and version (MapsSDKJS/<version>)
Every request, except in proxy mode Your API key, in a TomTom-Api-Key header or a key= URL parameter (which is which)

The header and the key are separate:

What travels in URLs

Some of this data goes in the URL instead of the request body. The path holds:

The query string holds:

URLs end up in places a request body doesn't: server access logs, CDN logs, proxy logs and error trackers. Strip query strings, and the path segments above, from any logs you keep, or redact these values before you store them.

Proxy mode and cookies

In proxy mode, the SDK sends every request with credentials: 'include'. The session cookie your proxy issues then travels with every service call and tile request.

The SDK never sets or reads that cookie. Your proxy does, so list it in your cookie notice as one of yours.

TomTom then sees your proxy's IP address instead of the user's, unless your proxy forwards it, for example in an X-Forwarded-For header. The rest of what this page lists still reaches TomTom, through your proxy.

Third parties

Core, Services and Map contact no third party. These cases depend on you:

The Agent Toolkit plugin sends data to more places than these. What the agent sends, and where covers it.

Next steps