--- title: "Maps API" description: "Core API for accessing MapTiler Cloud map styles." --- # Maps API ## Maps API reference Scalar API Reference - [ Introduction ](#description/introduction) - [ Maps ](#tag/maps) Close Group - Maps - [ Embeddable HTML viewer HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/) - [ Style JSON of the map HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/style.json) - [ Map symbols (sprites) HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/sprite{scale}.{format}) - [ Raster XYZ tiles HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format}) - [ TileJSON HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/{tileSize/}/tiles.json) - [ OGC API \- Tiles HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/tiles) - [ OGC API TileMatrixSets HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/tileMatrixSet) - [ WMTS Capabilities HTTP Method:  GET](#tag/maps/GET/maps/{mapId}/WMTSCapabilities.xml) [Powered by Scalar](https://www.scalar.com) v1.0 OpenAPI 3.1.0 # MapTiler API [Support](mailto:support@maptiler.com) [](https://docs.maptiler.com/support/requests/) [Terms of Service](https://www.maptiler.com/terms/) Server Server:https://api.maptiler.com MapTiler API ## AuthenticationRequired Selected Auth Type: key Client Libraries Shell Ruby Node.js PHP Python MoreSelect from all clients Shell Curl ## Maps ​Copy link Maps Operations - get/maps/{mapId}/ - get/maps/{mapId}/style.json - get/maps/{mapId}/sprite{scale}.{format} - get/maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format} - get/maps/{mapId}/{tileSize/}/tiles.json - get/maps/{mapId}/tiles - get/maps/{mapId}/tileMatrixSet - get/maps/{mapId}/WMTSCapabilities.xml ### Embeddable HTML viewer ​Copy link Auth Required Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 text/html Request Example for get/maps/_{mapId}_/ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/) Status: 200 No Body ### Style JSON of the map ​Copy link Auth Required Style JSON describing the map cartography. Can be used with various libraries to display a vector map (e.g. Mapbox GL JS, OpenLayers, ...). Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 application/json Request Example for get/maps/_{mapId}_/style.json Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/style.json?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/style.json) Status: 200 Show Schema ```json {} ``` Copy Copy deprecated ### Map symbols (sprites) ​Copy link Map symbols (sprites) required to display the vector map. **Deprecated:** use [Sprites API](https://docs.maptiler.com/cloud/api/other/GET/sprites/{spriteId}/sprite{scale}.{format}). Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - scaleCopy link to scale enum const:   @2x values - @2x - formatCopy link to format Type: string enum required values - png - json Responses - 200 Selected Content Type: application/json Request Example for get/maps/_{mapId}_/sprite_{scale}_._{format}_ Shell Curl ```curl curl https://api.maptiler.com/maps/streets-v4/sprite@2x.png ``` Copy Copy Test Request(get /maps/{mapId}/sprite{scale}.{format}) Status: 200 No Body ### Raster XYZ tiles ​Copy link Auth Required 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. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - tileSize/Copy link to tileSize/ enum const:   256 Integer numbers. values - 256 - zCopy link to z Type: integer required Zoom level. Specifies the tile's zoom level. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - xCopy link to x Type: integer required Column. Specifies the tile's column. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - yCopy link to y Type: integer required Row. Specifies the tile's row. See [Tiles à la Google Maps](https://docs.maptiler.com/google-maps-coordinates-tile-bounds-projection/) - scaleCopy link to scale enum const:   @2x Use "@2x" to get "retina"/HiDPI image. values - @2x - formatCopy link to format Type: string enum required values - png - jpg - webp - basis Responses - 200 image/\* - 400 Out of bounds / Invalid format Request Example for get/maps/_{mapId}_/_{tileSize/}_/_{z}_/_{x}_/_{y}__{scale}_._{format}_ Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/256/1/1/1@2x.png?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format}) Status: 200Status: 400 Show Schema ```json @filename ``` Copy Copy ### TileJSON ​Copy link Auth Required 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, ...). Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). - tileSize/Copy link to tileSize/ enum const:   256 Integer numbers. values - 256 Responses - 200 application/json Request Example for get/maps/_{mapId}_/_{tileSize/}_/tiles.json Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/256/tiles.json?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/{tileSize/}/tiles.json) Status: 200 Show Schema ```json {} ``` Copy Copy ### OGC API - Tiles ​Copy link Auth Required Tileset landing page of the rasterized tiles. Can be used in software supporting the OGC API - Tiles v1.0 specification. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 application/json Request Example for get/maps/_{mapId}_/tiles Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/tiles?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/tiles) Status: 200 Show Schema ```json string ``` Copy Copy ### OGC API TileMatrixSets ​Copy link Auth Required Description of the tileset tile matrix sets according to the OGC Web API. This resource is linked from the OGC API - Tiles endpoint. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 application/json Request Example for get/maps/_{mapId}_/tileMatrixSet Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/tileMatrixSet?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/tileMatrixSet) Status: 200 Show Schema ```json string ``` Copy Copy ### WMTS Capabilities ​Copy link Auth Required 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. Path Parameters - mapIdCopy link to mapId Type: string required Example streets-v4 Identifier of the map. See [MapTiler Maps](https://cloud.maptiler.com/maps/). Responses - 200 text/xml Request Example for get/maps/_{mapId}_/WMTSCapabilities.xml Shell Curl ```curl curl 'https://api.maptiler.com/maps/streets-v4/WMTSCapabilities.xml?key=YOUR_MAPTILER_API_KEY' ``` Copy Copy Test Request(get /maps/{mapId}/WMTSCapabilities.xml) Status: 200 Show Schema ```json string ``` Copy Copy ![](https://docs.maptiler.com/assets/img/open-api.png) Using the OpenAPI Specification? Get the [openapi.yaml](https://docs.maptiler.com/_data/cloud/api/openapi.yml)