Images API

Images API reference

Scalar API Reference
v1.0
OpenAPI 3.1.0

MapTiler API

Support
Terms of Service

MapTiler API

Client Libraries
Shell Curl

Images

​
Images Operations

ImageJSON

​

JSON describing the metadata of the image. Can be used with MapTiler SDK to display the image.

Path Parameters
  • imageId
    Type: string
    required

    Identifier of the image.

Responses
  • application/json
Request Example for get/images/{imageId}/image.json
curl 'https://api.maptiler.com/images/{imageId}/image.json?key=YOUR_SECRET_TOKEN'

{
  "id": "string",
  "description": "string",
  "attribution": "string",
  "width": 1,
  "height": 1,
  "minzoom": 1,
  "maxzoom": 1,
  "tileSize": 1
}

XYZ tiles

​

The individual tiles. Can be used with various libraries to display the image. It's better to use the ImageJSON with MapTiler SDK rather than using the tile URL directly.

Path Parameters
  • imageId
    Type: string
    required

    Identifier of the image.

  • 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

  • 403

    Key is missing, invalid or restricted

  • 404

    The item does not exist

Request Example for get/images/{imageId}/{z}/{x}/{y}
curl 'https://api.maptiler.com/images/{imageId}/1/1/1?key=YOUR_SECRET_TOKEN'
No Body
Using the OpenAPI Specification?
Get the openapi.yaml
Was this helpful?
MapTiler API
Images API
Images API