---
title: "Tiles API"
description: "API for accessing 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)

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

<table class="mb-0 grid min-h-8 auto-rows-auto" role="presentation" style="grid-template-columns:1fr;"><tbody><tr class="group contents"><td class="box-content min-h-8 min-w-8 border-l-0 border-t border-b-0 border-r flex text-base/5 last:border-r-0 group-last:border-b-transparent p-0 m-0 relative max-h-[auto] group-[.alert]:bg-b-alert group-[.error]:bg-b-danger" style="" aria-label="Your own API key from https://cloud.maptiler.com/"><div class="group/summary flex gap-0.5 flex-row items-baseline auth-description bg-b-1 text-c-2 min-w-0 flex-1 px-3 py-1.25" style=""><div class="markdown line-clamp-(--markdown-clamp) markdown-summary truncate" style="--markdown-clamp:1;" controlled="false" modelvalue="false" truncated="false" id="scalar-refs-0-9"><p>Your own API key from <a href="https://cloud.maptiler.com/" rel="nofollow" target="_blank">https://cloud.maptiler.com/</a></p></div></div></td></tr><tr class="group contents"><td class="box-content max-h-8 min-h-8 min-w-8 border-l-0 border-b-0 border-r text-base/5 last:border-r-0 group-last:border-b-transparent p-0 m-0 relative flex border-t group-[.alert]:bg-b-alert group-[.error]:bg-b-danger" style="" data-v-a6f4752a=""><div class="text-c-1 flex items-center pr-0 pl-3" for="scalar-refs-0-10" data-v-a6f4752a=""><label for="scalar-refs-0-10">Name </label>:</div><div class="relative flex min-w-0 flex-1" data-v-a6f4752a=""><div id="scalar-refs-0-10" class="text-c-1 disabled:text-c-2 peer w-full min-w-0 border-none -outline-offset-1 code-input-lite group/code-input-lite peer relative w-full leading-[1.44] -outline-offset-1 has-[:focus-visible]:rounded-[4px] has-[:focus-visible]:outline code-input-lite--empty" data-v-4dfd05a3=""><div aria-autocomplete="list" class="code-input-lite__editor" contenteditable="true" data-placeholder="api-key" role="combobox" spellcheck="false" data-v-4dfd05a3=""></div></div></div><button aria-disabled="false" type="button" class="scalar-icon-button grid aspect-square cursor-pointer scalar-button-ghost bg-transparent text-c-2 active:text-c-1 hover:text-c-1 size-8 m-1 -outline-offset-2 rounded-lg -ml-.25 h-6 w-6 self-center p-1.25" style="" data-v-a6f4752a=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor" width="1em" height="1em" aria-hidden="true" role="presentation" class="size-full" style=""><g><path d="M205.66,194.34a8,8,0,0,1-11.32,11.32L128,139.31,61.66,205.66a8,8,0,0,1-11.32-11.32L116.69,128,50.34,61.66A8,8,0,0,1,61.66,50.34L128,116.69l66.34-66.35a8,8,0,0,1,11.32,11.32L139.31,128Z"></path></g></svg><span class="sr-only">Clear Value</span></button></td></tr><tr class="group contents"><td class="box-content max-h-8 min-h-8 min-w-8 border-l-0 border-t border-b-0 border-r text-base/5 last:border-r-0 group-last:border-b-transparent p-0 m-0 relative flex group-[.alert]:bg-b-alert group-[.error]:bg-b-danger" style="" data-v-a6f4752a=""><div class="text-c-1 flex items-center pr-0 pl-3" for="scalar-refs-0-11" data-v-a6f4752a=""><label for="scalar-refs-0-11">Value </label>:</div><div class="relative flex min-w-0 flex-1" data-v-a6f4752a=""><input placeholder="QUxMIFlPVVIgQkFTRSBBUkUgQkVMT05HIFRPIFVT" id="scalar-refs-0-11" autocomplete="off" class="text-c-1 disabled:text-c-2 peer w-full min-w-0 border-none px-2 py-1.25 -outline-offset-1 scalar-password-input" data-1p-ignore="" spellcheck="false" type="text" value="YOUR_MAPTILER_API_KEY" data-v-a6f4752a=""></div><button aria-disabled="false" type="button" class="scalar-icon-button grid aspect-square cursor-pointer scalar-button-ghost bg-transparent text-c-2 active:text-c-1 hover:text-c-1 size-8 m-1 -outline-offset-2 rounded-lg -ml-.25 h-6 w-6 self-center p-1.25" style="" data-v-a6f4752a=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor" width="1em" height="1em" aria-hidden="true" role="presentation" class="size-full" style=""><g><path d="M205.66,194.34a8,8,0,0,1-11.32,11.32L128,139.31,61.66,205.66a8,8,0,0,1-11.32-11.32L116.69,128,50.34,61.66A8,8,0,0,1,61.66,50.34L128,116.69l66.34-66.35a8,8,0,0,1,11.32,11.32L139.31,128Z"></path></g></svg><span class="sr-only">Clear Value</span></button><button aria-disabled="false" type="button" class="scalar-icon-button grid aspect-square cursor-pointer scalar-button-ghost bg-transparent text-c-2 active:text-c-1 hover:text-c-1 size-8 m-1 -outline-offset-2 rounded-lg -ml-.5 mr-1.25 h-6 w-6 self-center p-1.25" style="" data-testid="data-table-password-toggle" data-v-a6f4752a=""><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor" width="1em" height="1em" aria-hidden="true" role="presentation" class="size-full" style=""><g><path d="M247.31,124.76c-.35-.79-8.82-19.58-27.65-38.41C194.57,61.26,162.88,48,128,48S61.43,61.26,36.34,86.35C17.51,105.18,9,124,8.69,124.76a8,8,0,0,0,0,6.5c.35.79,8.82,19.57,27.65,38.4C61.43,194.74,93.12,208,128,208s66.57-13.26,91.66-38.34c18.83-18.83,27.3-37.61,27.65-38.4A8,8,0,0,0,247.31,124.76ZM128,192c-30.78,0-57.67-11.19-79.93-33.25A133.47,133.47,0,0,1,25,128,133.33,133.33,0,0,1,48.07,97.25C70.33,75.19,97.22,64,128,64s57.67,11.19,79.93,33.25A133.46,133.46,0,0,1,231.05,128C223.84,141.46,192.43,192,128,192Zm0-112a48,48,0,1,0,48,48A48.05,48.05,0,0,0,128,80Zm0,80a32,32,0,1,1,32-32A32,32,0,0,1,128,160Z"></path></g></svg><span class="sr-only">Show Password</span></button></td></tr></tbody></table>

Client Libraries

Shell

Ruby

Node.js

PHP

Python

MoreSelect from all clients

Shell Curl

## Tiles

​Copy link

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

Auth Required

Path Parameters

-   tilesIdCopy link to tilesId
    
    Type: string
    
    required
    
    Example
    
    satellite-v4
    
    Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/).
    

Responses

-   200
    
    text/html
    

Request Example for get/tiles/_{tilesId}_/

Shell Curl

```curl
curl 'https://api.maptiler.com/tiles/satellite-v4/?key=YOUR_MAPTILER_API_KEY'
```

Copy

Copy

Test Request(get /tiles/{tilesId}/)

Status: 200

No Body

### XYZ tiles

​Copy link

Auth Required

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
    
    satellite-v4
    
    Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/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
    
    \*
    
-   204
    
    Tile not present -- presumed empty (empty response)
    
-   400
    
    Out of bounds
    
-   403
    
    Key is missing, invalid or restricted
    
-   404
    
    The item does not exist
    

Request Example for get/tiles/_{tilesId}_/_{z}_/_{x}_/_{y}_

Shell Curl

```curl
curl 'https://api.maptiler.com/tiles/satellite-v4/1/1/1?key=YOUR_MAPTILER_API_KEY'
```

Copy

Copy

Test Request(get /tiles/{tilesId}/{z}/{x}/{y})

Status: 200Status: 204Status: 400Status: 403Status: 404

No Body

### TileJSON

​Copy link

Auth Required

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
    
    satellite-v4
    
    Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/).
    

Responses

-   200
    
    application/json
    

Request Example for get/tiles/_{tilesId}_/tiles.json

Shell Curl

```curl
curl 'https://api.maptiler.com/tiles/satellite-v4/tiles.json?key=YOUR_MAPTILER_API_KEY'
```

Copy

Copy

Test Request(get /tiles/{tilesId}/tiles.json)

Status: 200

Show Schema 

```json
{}
```

Copy

Copy

### OGC API - Tiles

​Copy link

Auth Required

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
    
    satellite-v4
    
    Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/).
    

Responses

-   200
    
    application/json
    

Request Example for get/tiles/_{tilesId}_/tiles

Shell Curl

```curl
curl 'https://api.maptiler.com/tiles/satellite-v4/tiles?key=YOUR_MAPTILER_API_KEY'
```

Copy

Copy

Test Request(get /tiles/{tilesId}/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

-   tilesIdCopy link to tilesId
    
    Type: string
    
    required
    
    Example
    
    satellite-v4
    
    Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/).
    

Responses

-   200
    
    application/json
    

Request Example for get/tiles/_{tilesId}_/tileMatrixSet

Shell Curl

```curl
curl 'https://api.maptiler.com/tiles/satellite-v4/tileMatrixSet?key=YOUR_MAPTILER_API_KEY'
```

Copy

Copy

Test Request(get /tiles/{tilesId}/tileMatrixSet)

Status: 200

Show Schema 

```json
string
```

Copy

Copy

### WMTS Capabilities

​Copy link

Auth Required

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
    
    satellite-v4
    
    Identifier of the tiles. See [MapTiler Tiles](https://cloud.maptiler.com/tiles/).
    

Responses

-   200
    
    text/xml
    

Request Example for get/tiles/_{tilesId}_/WMTSCapabilities.xml

Shell Curl

```curl
curl 'https://api.maptiler.com/tiles/satellite-v4/WMTSCapabilities.xml?key=YOUR_MAPTILER_API_KEY'
```

Copy

Copy

Test Request(get /tiles/{tilesId}/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)
