Maps API

Maps 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

Maps

​

Serve and render self-hosted vector and raster maps.

Maps Operations

Embeddable HTML viewer

​
Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

Responses
  • text/html
  • 404

    The item does not exist

Request Example for get/maps/{mapId}
curl http://localhost:3650/api/maps/streets
No Body

OK

Style JSON of the map

​

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

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/style.json
curl http://localhost:3650/api/maps/streets/style.json

{}

OK

Map symbols (sprites)

​

Map symbols (sprites) required to display the vector map.

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

  • scale
    Type: string enum
    required

    Use "@2x" to get "retina"/HiDPI image.

    values
    • @2x
  • format
    Type: string enum
    required
    values
    • png
    • json
Responses
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/sprite{scale}.{format}
curl http://localhost:3650/api/maps/streets/sprite.png
No Body

OK

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.

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

  • tileSize
    Type: string enum
    required
    values
    • 256
    • 512
  • 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

  • scale
    Type: string enum
    required

    Use "@2x" to get "retina"/HiDPI image.

    values
    • @2x
  • format
    Type: string enum
    required

    The value depends on the Map settings.

    values
    • png
    • jpg
    • webp
Responses
  • image/*
  • 400

    Out of bounds / Invalid format

  • 404

    The item does not exist

Request Example for get/maps/{mapId}/{tileSize}/{z}/{x}/{y}{scale}.{format}
curl http://localhost:3650/api/maps/streets//1/1/1.png

@filename

OK

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, ...).

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

  • tileSize
    Type: string enum
    required
    values
    • 256
    • 512
Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/{tileSize}/tiles.json
curl http://localhost:3650/api/maps/streets//tiles.json

{}

OK

OGC API - Tiles

​

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

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/tiles
curl http://localhost:3650/api/maps/streets/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
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

Responses
  • application/json
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/tileMatrixSet
curl http://localhost:3650/api/maps/streets/tileMatrixSet

string

OK

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.

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

Responses
  • text/xml
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/WMTSCapabilities.xml
curl http://localhost:3650/api/maps/streets/WMTSCapabilities.xml

string

OK

WMTS Capabilities for all layers

​

WMTS Capabilities XML document describing the metadata of all map layers as well as link to the XYZ tiles. Can be used with various GIS software (e.g. QGIS) to display the map.

Responses
  • text/xml
  • 404

    The item does not exist

Request Example for get/WMTSCapabilities.xml
curl http://localhost:3650/api/WMTSCapabilities.xml

string

OK

WMS Capabilities

​

WMS Capabilities XML document describing the metadata of the map. Can be used with various GIS software (e.g. QGIS) to display the map.

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Server Maps http://localhost:3650/admin/.

Query Parameters
  • service
    enum
    const:  
    WMS
    required
    values
    • WMS
  • request
    enum
    const:  
    GetCapabilities
    required
    values
    • GetCapabilities
Responses
  • text/xml
  • 404

    The item does not exist

Request Example for get/maps/{mapId}/wms
curl 'http://localhost:3650/api/maps/streets/wms?service=WMS&request=GetCapabilities'

string

OK

WMS Capabilities for all layers

​

WMS capabilities XML document describing the metadata of all map layers. Can be used with various GIS software (e.g. QGIS) to display the map.

Query Parameters
  • service
    enum
    const:  
    WMS
    required
    values
    • WMS
  • request
    enum
    const:  
    GetCapabilities
    required
    values
    • GetCapabilities
Responses
  • text/xml
  • 404

    The item does not exist

Request Example for get/maps/wms
curl 'http://localhost:3650/api/maps/wms?service=WMS&request=GetCapabilities'

string

OK

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