Introduction
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:
Synchronous Snap to Roads
This endpoint provides detailed information of a reconstructed road in an efficient way.
Asynchronous Snap to Roads Submission
This endpoint enables the asynchronous batch submission.
Asynchronous Snap to Roads Status
This endpoint lets clients check the status of a job they submitted.
Asynchronous Snap to Roads Download
This endpoint lets clients download the result of the Asynchronous Snap To Roads Submission.
Getting Started
Use the following topics to become more acquainted with this API and its endpoints.
How to get a TomTom API Key
When you use our location Service APIs, we need a way to identify that it is your application that is making the request to use the service (API).
TomTom Knowledge Base
The TomTom Knowledge Base optimizes the retrieval of information via articles, blogs, FAQs, tutorials, and videos for your use and reference.
How to Reconstruct a Route from Data Points with the Snap to Roads API
In this easy-to-follow tutorial, you will learn about the TomTom Snap to Roads API and how you can use it to reconstruct a route. We will also show you how to integrate the route into an app (we have used React here, but you can also use Angular or Vue) to ensure you get a perfect reconstruction.
Journey Speed Limit Review with the TomTom Snap to Roads API
The TomTom Snap to Roads API works by taking two coordinates to create the optimal route, factoring in speed limit, types of roads, vehicle type, and elevation. It can also take a GPS trace and recreate the journey of a driver. The goal of this API is to understand the performance of the driver on the journey.
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.
Endpoint type | Max number | Max number | Max road distance per route | Max QPS |
|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|