API Style Engine

Maps API

Embeddable HTML viewer

GET https://api.maptiler.com/maps/{mapId}/

Request

Security: API Key

Path Parameters

Parameters Type Description
mapId string
Identifier of the map. See MapTiler Cloud Maps.
Example: streets
Request example

  https://api.maptiler.com/maps/streets/?key=YOUR_MAPTILER_API_KEY

Responses

Code Content Description
200 text/html

Style JSON of the map

GET https://api.maptiler.com/maps/{mapId}/style.json

Style JSON describing the map cartography. Can be used with various libraries to display a vector map (e.g. Mapbox GL JS, OpenLayers, ...).

Request

Security: API Key

Path Parameters

Parameters Type Description
mapId string
Identifier of the map. See MapTiler Cloud Maps.
Example: streets
Request example

  https://api.maptiler.com/maps/streets/style.json?key=YOUR_MAPTILER_API_KEY

Responses

Code Content Description
200 application/json Style JSON object https://docs.mapbox.com/mapbox-gl-js/style-spec/

Map symbols (sprites)

GET https://api.maptiler.com/maps/{mapId}/sprite{scale}.{format}

Map symbols (sprites) required to display the vector map.

Request

Path Parameters

Parameters Type Description
mapId string
Identifier of the map. See MapTiler Cloud Maps.
Example: streets
scale string
Allowed values: @2x
format string
Allowed values: png json
Request example

  https://api.maptiler.com/maps/streets/sprite.png?key=YOUR_MAPTILER_API_KEY

Responses

Code Content Description
200 application/json
200 image/png

Raster XYZ tiles

GET https://api.maptiler.com/maps/{mapId}/{tileSize}/{z}/{x}/{y}{scale}.{format}

Rasterized tiles (XYZ) of the map. Can be used with various libraries to display a raster map (e.g. Leaflet, OpenLayers, ...). It's usually better (if possible) to use the TileJSON rather than using the tile URL directly.

Request

Security: API Key

Path Parameters

Parameters Type Description
mapId string
Identifier of the map. See MapTiler Cloud Maps.
Example: streets
tileSize integer
Allowed values: 256
z integer
x integer
y integer
scale string
Use “@2x” to get “retina”/HiDPI image.
Allowed values: @2x
format string
The value depends on the Map settings.
Allowed values: png jpg webp
Request example

  https://api.maptiler.com/maps/streets/10/518/352.png?key=YOUR_MAPTILER_API_KEY

Responses

Code Content Description
200 image/*

TileJSON

GET https://api.maptiler.com/maps/{mapId}/{tileSize}/tiles.json

TileJSON describing the metadata of the map as well as link to the XYZ tiles. Can be used with various libraries to display a raster map (e.g. Leaflet, OpenLayers, ...).

Request

Security: API Key

Path Parameters

Parameters Type Description
mapId string
Identifier of the map. See MapTiler Cloud Maps.
Example: streets
tileSize integer
Allowed values: 256
Request example

  https://api.maptiler.com/maps/streets/tiles.json?key=YOUR_MAPTILER_API_KEY

Responses

Code Content Description
200 application/json https://raw.githubusercontent.com/mapbox/tilejson-spec/master/2.2.0/schema.json

WMTS Capabilities

GET https://api.maptiler.com/maps/{mapId}/WMTSCapabilities.xml

WMTS Capabilities XML document describing the metadata of the map as well as link to the XYZ tiles. Can be used with various GIS software (e.g. QGIS) to display the map.

Request

Security: API Key

Path Parameters

Parameters Type Description
mapId string
Identifier of the map. See MapTiler Cloud Maps.
Example: streets
Request example

  https://api.maptiler.com/maps/streets/WMTSCapabilities.xml?key=YOUR_MAPTILER_API_KEY

Responses

Code Content Description
200 text/xml