What is TomTom's Snap to Roads API?

The TomTom Snap to Roads API and service offers a solution to enable you to get the most out of your applications, and grants you the ability to use advanced map data. It is a web service designed for developers to create web and mobile applications responsible for matching received points (gathered from GPS devices) to map a road network and reconstruct the road driven by a customer, and provides detailed information about the matched route. These web services can be used via REST APIs.

The offering includes the following endpoints. See the Endpoint descriptions section for more details:

Getting started

1. To get your API Key, you first need to be registered for the TomTom Developer Portal. If you don't have an account, no worries! Register / Sign in now before continuing.
2. Once you are registered, go to your Dashboard and locate the API Key that you would like to use (we've created the first one for you, it's called My first API Key).
3. Read the documentation and start coding.
4. Consider using the TomTom Maps SDK for Web, for iOS, and for Android.

Endpoint descriptions

GET Synchronous Snap to Roads

This endpoint provides detailed information of a reconstructed road in an efficient way. The Synchronous Snap to Roads endpoint matches the received points to the map road network and reconstructs the driven road. Points given as input to the Synchronous Snap to Roads endpoint are related to themselves and are a part of the same route from the same client.

The matching algorithm chooses the driven road fitting to all of the given points, or in case of a few possibilities takes into account additional restrictions provided by the client. This endpoint can also provide extended data related to a matched route.

This endpoint can be used for:

• Reconstructing the driven road and getting the detailed insights for it.
• Providing innovative information in order to build applications with advanced map data.

POST Asynchronous Snap to Roads Submission

This endpoint enables the Asynchronous Snap To Roads Submission. It responds with a unique job id which can be used to check the job status and download its result when available.

GET Asynchronous Snap to Roads Status

This endpoint lets clients check the status of a job they submitted.

GET Asynchronous Snap to Roads Download

This endpoint lets clients download the result of the Asynchronous Snap To Roads Submission endpoint. A unique batch id is required to download the Asynchronous Snap To Roads Submission request result. This id is available inside the body of a successful Asynchronous Snap To Roads Submission response.

To download the result, the job must be in the Completed state. The current state of a job may be checked using the Asynchronous Snap To Roads Status endpoint. The result of a completed job will be included in the HTTP 200 response body. A result download request for a non-Completed job will end with an HTTP 404 response.

API Limitations

• The Freemium and Pay as you grow pricing plans support up to 5000 points and up to 100 km of road distance in a single request.
• The Enterprise pricing plan supports higher limits. Check our Pricing and Contact Sales for quotas tailored based on your needs.
• All pricing plans support both synchronous and asynchronous endpoints.