APIs
Authentication
Admin API
On This Page
Maps API
Embeddable HTML viewer
Request
Security: API Key
Path Parameters
Parameters | Type | Description |
---|---|---|
mapId | string |
Identifier of the map. See MapTiler Cloud Maps
Example:
streets
|
Example requests
https://api.maptiler.com/maps/streets/?key=YOUR_MAPTILER_API_KEY
Response
Code | Content | Description |
---|---|---|
200 | text/html |
Style JSON of the map
Style JSON describing the map cartography. Can be used with various libraries to display a vector map (e.g. MapLibre GL JS, OpenLayers, …).
Request
Security: API Key
Path Parameters
Parameters | Type | Description |
---|---|---|
mapId | string |
Identifier of the map. See MapTiler Cloud Maps
Example:
streets
|
Example requests
https://api.maptiler.com/maps/streets/style.json?key=YOUR_MAPTILER_API_KEY
Response
Code | Content | Description |
---|---|---|
200 | application/json | Style JSON object https://docs.maptiler.com/gl-style-specification/ |
Map symbols (sprites)
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
|
Example requests
https://api.maptiler.com/maps/streets/sprite.png
Response
Code | Content | Description |
---|---|---|
200 | application/json or image/png |
Raster XYZ tiles
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
|
Example requests
https://api.maptiler.com/maps/streets/10/518/352.png?key=YOUR_MAPTILER_API_KEY
Response
Code | Content | Description |
---|---|---|
200 | image/png or image/jpeg or image/webp |
TileJSON
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
|
Example requests
https://api.maptiler.com/maps/streets/tiles.json?key=YOUR_MAPTILER_API_KEY
Response
Code | Content | Description |
---|---|---|
200 | application/json | TileJSON object https://documentation.maptiler.com/hc/en-us/articles/4405591904913-TileJSON-for-map-tiles |
WMTS Capabilities
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
|
Example requests
https://api.maptiler.com/maps/streets/WMTSCapabilities.xml?key=YOUR_MAPTILER_API_KEY
Response
Code | Content | Description |
---|---|---|
200 | text/xml |