Sorry, you need to enable JavaScript to visit this website.

Snap to Roads API Documentation

 

Service version: 1
Last edit: 2021.10.26


The Snap to Roads API offering includes the following endpoints:

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.

▲ Return to top