Introduction
Important notes:
- This TomTom Orbis API is in public preview.
- This API is powered by TomTom Orbis Maps.
- See the TomTom Orbis Maps documentation for more information.
What is the TomTom Orbis Maps Map Display API?
The Map Display API is a suite of web services designed for developers to create maps for web and mobile applications. These web services can be used via RESTful APIs.
Maps are displayed using tiles. The Map Display API distributes tiles in two formats. Find out more about these formats in Which map style is right for you.
- Vector tiles. This means the Map Display API Vector Tile endpoint returns map data to your client instead of map images.
- You can style and customize vector tiles using Assets API.
- Raster tiles. This means the Map Display API returns map images instead of map data to your client. These images can be displayed without the need for a renderer.
- Imagery of satellite and hillshade are also supported.
Overlaying traffic information on the map is easy. The Traffic API documentation explains how to do this.
Endpoints
The Map Display API consists of the the following endpoints:
- Map Display Vector Tiles. The Vector Tiles service provides geographic map data in vector format.
- Map Display Raster Tiles. The Raster Tiles service provides geographic map data as a rendered image.
- Copyrights. The Copyrights service is designed to serve copyright information for the Map Display services.
Styles
Various styles are available for the display of map data. They can be customized to suit specific needs. The Assets API documentation explains how to do this.
- street-light style
- street-light_driving style
- street-dark style
- street-dark_driving style
- mono-light style
- mono-dark style
- street-satellite style
Common use cases you can implement
Map Display using vector tiles
You use vector tiles if you have a renderer compatible with the MapLibre Style specification to render the vector data on your client. This is most suitable if you want to want to have maximum flexibility over the way the map is displayed. If you are looking for a simple way to render data on the client while still having lots of flexibility on the display of the map, consider using the Maps SDK. This already includes a renderer, so you do not have to worry about this yourself.
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.
Map Display API Overview
This Overview page uses Frequently Asked Questions and provides answers regarding the TomTom Maps Display API.
Getting Started with the TomTom Maps APIs
A getting started instructional video.