Tiles API

Tiles API reference

Scalar API Reference
v4.8.0
OpenAPI 3.1.0

MapTiler Server API

Support
MapTiler Server License Agreement
Terms of Service
Server:http://{host}/api

MapTiler Server API

Client Libraries
Shell Curl

Tiles

​

Serve and render self-hosted tilesets.

Tiles Operations

Embeddable HTML viewer

​
Path Parameters
  • tilesId
    Type: string
    required

    Identifier of the tiles. See MapTiler Server Tiles http://localhost:3650/admin/tiles/.

Responses
  • text/html
  • 404

    The item does not exist

Request Example for get/tiles/{tilesId}
curl http://localhost:3650/api/tiles/maptiler-satellite
No Body

OK

XYZ tiles

​

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
  • tilesId
    Type: string
    required

    Identifier of the tiles. See MapTiler Server Tiles http://localhost:3650/admin/tiles/.

  • z
    Type: integer
    required

    Zoom level. Specifies the tile's zoom level. See Tiles à la Google Maps

  • x
    Type: integer
    required

    Column. Specifies the tile's column. See Tiles à la Google Maps

  • y
    Type: integer
    required

    Row. Specifies the tile's row. See Tiles à la Google Maps

Responses
  • *
  • 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}
curl http://localhost:3650/api/tiles/maptiler-satellite/1/1/1
No Body

OK

TileJSON

​

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
  • tilesId
    Type: string
    required

    Identifier of the tiles. See MapTiler Server Tiles http://localhost:3650/admin/tiles/.

Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/tiles/{tilesId}/tiles.json
curl http://localhost:3650/api/tiles/maptiler-satellite/tiles.json

{}

OK

OGC API - Tiles

​

Tileset landing page of the tiles. Can be used in software supporting the OGC API - Tiles v1.0 specification.

Path Parameters
  • tilesId
    Type: string
    required

    Identifier of the tiles. See MapTiler Server Tiles http://localhost:3650/admin/tiles/.

Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/tiles/{tilesId}/tiles
curl http://localhost:3650/api/tiles/maptiler-satellite/tiles

string

OK

OGC API TileMatrixSets

​

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
  • tilesId
    Type: string
    required

    Identifier of the tiles. See MapTiler Server Tiles http://localhost:3650/admin/tiles/.

Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/tiles/{tilesId}/tileMatrixSet
curl http://localhost:3650/api/tiles/maptiler-satellite/tileMatrixSet

string

OK

WMTS Capabilities

​

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
  • tilesId
    Type: string
    required

    Identifier of the tiles. See MapTiler Server Tiles http://localhost:3650/admin/tiles/.

Responses
  • text/xml
  • 404

    The item does not exist

Request Example for get/tiles/{tilesId}/WMTSCapabilities.xml
curl http://localhost:3650/api/tiles/maptiler-satellite/WMTSCapabilities.xml

string

OK

Using the OpenAPI Specification?
Get the openapi.yaml
Was this helpful?