Maps API

Maps API reference

Scalar API Reference
v1.0
OpenAPI 3.1.0

MapTiler API

Support
Terms of Service
Server:https://api.maptiler.com

MapTiler API

Client Libraries
Shell Curl

Maps

​
Maps Operations

Embeddable HTML viewer

​
Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Maps.

Responses
  • text/html
Request Example for get/maps/{mapId}/
curl 'https://api.maptiler.com/maps/streets-v4/?key=YOUR_SECRET_TOKEN'
No Body

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 Maps.

Responses
  • application/json
Request Example for get/maps/{mapId}/style.json
curl 'https://api.maptiler.com/maps/streets-v4/style.json?key=YOUR_SECRET_TOKEN'

{}
deprecated

Map symbols (sprites)

​

Map symbols (sprites) required to display the vector map.
Deprecated: use Sprites API.

Path Parameters
  • mapId
    Type: string
    required

    Identifier of the map. See MapTiler Maps.

  • scale
    enum
    const:  
    @2x
    values
    • @2x
  • format
    Type: string enum
    required
    values
    • png
    • json
Responses
Request Example for get/maps/{mapId}/sprite{scale}.{format}
curl https://api.maptiler.com/maps/streets-v4/sprite@2x.png
No Body

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 Maps.

  • tileSize/
    enum
    const:  
    256

    Integer numbers.

    values
    • 256
  • 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
    enum
    const:  
    @2x

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

    values
    • @2x
  • format
    Type: string enum
    required
    values
    • png
    • jpg
    • webp
    • basis
Responses
  • image/*
  • 400

    Out of bounds / Invalid format

Request Example for get/maps/{mapId}/{tileSize/}/{z}/{x}/{y}{scale}.{format}
curl 'https://api.maptiler.com/maps/streets-v4/256/1/1/1@2x.png?key=YOUR_SECRET_TOKEN'

@filename

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 Maps.

  • tileSize/
    enum
    const:  
    256

    Integer numbers.

    values
    • 256
Responses
  • application/json
Request Example for get/maps/{mapId}/{tileSize/}/tiles.json
curl 'https://api.maptiler.com/maps/streets-v4/256/tiles.json?key=YOUR_SECRET_TOKEN'

{}

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 Maps.

Responses
  • application/json
Request Example for get/maps/{mapId}/tiles
curl 'https://api.maptiler.com/maps/streets-v4/tiles?key=YOUR_SECRET_TOKEN'

string

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 Maps.

Responses
  • application/json
Request Example for get/maps/{mapId}/tileMatrixSet
curl 'https://api.maptiler.com/maps/streets-v4/tileMatrixSet?key=YOUR_SECRET_TOKEN'

string

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 Maps.

Responses
  • text/xml
Request Example for get/maps/{mapId}/WMTSCapabilities.xml
curl 'https://api.maptiler.com/maps/streets-v4/WMTSCapabilities.xml?key=YOUR_SECRET_TOKEN'

string
Using the OpenAPI Specification?
Get the openapi.yaml
Was this helpful?
MapTiler API
Maps API
Maps API