--- title: "Tiles API" description: "API reference for requesting vector and raster map tiles." --- > For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL. # Tiles API ## Tiles API reference Scalar API Reference - [ Introduction ](#description/introduction) - [ Tiles ](#tag/tiles) Close Group - Tiles - [ Embeddable HTML viewer HTTP Method:  GET](#tag/tiles/GET/tiles/{tilesId}) - [ XYZ tiles HTTP Method:  GET](#tag/tiles/GET/tiles/{tilesId}/{z}/{x}/{y}) - [ TileJSON HTTP Method:  GET](#tag/tiles/GET/tiles/{tilesId}/tiles.json) - [ OGC API \- Tiles HTTP Method:  GET](#tag/tiles/GET/tiles/{tilesId}/tiles) - [ OGC API TileMatrixSets HTTP Method:  GET](#tag/tiles/GET/tiles/{tilesId}/tileMatrixSet) - [ WMTS Capabilities HTTP Method:  GET](#tag/tiles/GET/tiles/{tilesId}/WMTSCapabilities.xml) [Powered by Scalar](https://www.scalar.com) v4.9.0 OpenAPI 3.1.0 # MapTiler Server API [Support](mailto:support@maptiler.com) [](https://support.maptiler.com) [MapTiler Server License Agreement](https://www.maptiler.com/server/license/) [Terms of Service](https://www.maptiler.com/server/license/) Server Server:http://{host}/api host MapTiler Server API Client Libraries Shell Ruby Node.js PHP Python MoreSelect from all clients Shell Curl ## Tiles ​Copy link Serve and render self-hosted tilesets. Tiles Operations - get/tiles/{tilesId} - get/tiles/{tilesId}/{z}/{x}/{y} - get/tiles/{tilesId}/tiles.json - get/tiles/{tilesId}/tiles - get/tiles/{tilesId}/tileMatrixSet - get/tiles/{tilesId}/WMTSCapabilities.xml ### Embeddable HTML viewer ​Copy link Path Parameters - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK text/html - 404 The item does not exist Request Example for get/tiles/_{tilesId}_ Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite ``` Copy Copy Status: 200Status: 404 No Body OK ### XYZ tiles ​Copy link The individual tiles. Can be used with various libraries to display the tiles (e.g. Leaflet, OpenLayers, ...). It's usually better (if possible) to use the TileJSON rather than using the tile URL directly. Path Parameters - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. - 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/) Responses - 200 OK \* - 204 Tile not present -- presumed empty (empty response) - 400 Out of bounds - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/_{z}_/_{x}_/_{y}_ Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/1/1/1 ``` Copy Copy Status: 200Status: 204Status: 400Status: 404 No Body OK ### TileJSON ​Copy link TileJSON describing the metadata of the tiles as well as link to the XYZ tiles. Can be used with various libraries to display the tiles (e.g. Leaflet, OpenLayers, ...). Path Parameters - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/tiles.json Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/tiles.json ``` Copy Copy Status: 200Status: 404 Show Schema ```json {} ``` Copy Copy OK ### OGC API - Tiles ​Copy link Tileset landing page of the tiles. Can be used in software supporting the OGC API - Tiles v1.0 specification. Path Parameters - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/tiles Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/tiles ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### OGC API TileMatrixSets ​Copy link 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 - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK application/json - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/tileMatrixSet Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/tileMatrixSet ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ### WMTS Capabilities ​Copy link WMTS Capabilities XML document describing the metadata of the tiles as well as link to the XYZ tiles. Can be used with various GIS software (e.g. QGIS) to display the tiles. Path Parameters - tilesIdCopy link to tilesId Type: string required Example maptiler-satellite Identifier of the tiles. See MapTiler Server Tiles `http://localhost:3650/admin/tiles/`. Responses - 200 OK text/xml - 404 The item does not exist Request Example for get/tiles/_{tilesId}_/WMTSCapabilities.xml Shell Curl ```curl curl http://localhost:3650/api/tiles/maptiler-satellite/WMTSCapabilities.xml ``` Copy Copy Status: 200Status: 404 Show Schema ```json string ``` Copy Copy OK ![](https://docs.maptiler.com/assets/img/open-api.png) Using the OpenAPI Specification? Get the [openapi.yaml](https://docs.maptiler.com/_data/server/api/openapi.yml)