About Maps SDK for JavaScript

We have released some capabilities in the Maps SDK under Public Preview to collect feedback from the community. While our goal is to keep the design of the interface stable, breaking changes will occur, particularly in the earlier versions. The versions will follow a 0.MAJOR.MINOR pattern for the time being. Stay tuned with our release CHANGELOG.md files.

Quickstart

Get your TomTom API key:

Sign up or log in at my.tomtom.com.
Create an API key following these instructions.

Install the SDK:

npm install @tomtom-org/maps-sdk

Start building:

Using an AI coding agent? Install the /tomtom-maps-sdk-js skill for SDK-specific assistance:

npx skills add tomtom-international/maps-sdk-js --skill tomtom-maps-sdk-js

Follow the Map Quickstart to display your first map.
Or try the Services Quickstart to call search, geocoding, or routing APIs.

For more project setup details, see the Project Setup Guide.

AI Coding Agent Skill

This repository ships a /tomtom-maps-sdk-js skill with SDK-specific knowledge for AI coding agents (Claude Code, Cursor, GitHub Copilot, Windsurf, and many more). See the Project Setup Guide for installation instructions.

Overview

Maps SDK JS is a JavaScript/TypeScript library for building applications using TomTom map display and geolocation APIs.

It leverages the power of MapLibre GL JS and GeoJSON to seamlessly integrate TomTom maps and services with convenient out-of-the-box support, while staying highly customizable and extensible.

Key Features

Interactive Maps: MapLibre-powered library for styled, service-compatible TomTom Maps
Comprehensive Services: Easy access to TomTom's location APIs including search, routing, and geocoding
GeoJSON Support: Built-in compatibility with the widely-used geospatial data format
TypeScript Ready: Full TypeScript support with comprehensive type definitions
Modular Architecture: Use only the features you need with tree-shaking support

Where can you run it?

Web: Display and configure maps, search for places, plan routes, and interact with location data
Node.js: Server-side geocoding, route calculation, and data enrichment capabilities
React Native: Leverage TomTom location services from a single codebase

Bundles

The Maps SDK is made up of three bundles:

Map: MapLibre-powered library for interactive TomTom Maps with modules for places, routes, traffic, and more.
Services: GeoJSON services for TomTom location APIs: search, routing, geocoding, EV charging availability, and geometry data.
Core: Shared configuration, types, and utilities used across Map and Services bundles.