API Reference

Raster Tiles API Reference

Base URL

https://rtc-cdn.maptoolkit.net/rtc

Endpoints

`GET /{style}.json`

Get TileJSON metadata for a raster tile style

Returns a TileJSON 2.2.0 document describing the raster tile source. Append @2x before .json for the retina tile source.

Parameter	In	Type	Required	Description
`style`	path	string	Yes	Map style name. Append `@2x` before the file extension for retina tiles (e.g. `maptoolkit-maptoolkit.summer@2x.json`).

Status	Description
`200`	TileJSON 2.2.0 document.

`GET /{style}/{z}/{x}/{y}.png`

Get a raster map tile

Returns a 256×256 PNG map tile at the given zoom level and tile coordinates. For retina displays, append @2x to the filename (e.g. /maptoolkit-maptoolkit.summer/12/2197/1420@2x.png) to get a 512×512 tile. Zoom level 0 is not supported — tiles start at zoom level 1.

Parameter	In	Type	Required	Description
`style`	path	string	Yes	Map style name. Append `@2x` before the file extension for retina tiles (e.g. `maptoolkit-maptoolkit.summer@2x.json`).
`z`	path	integer	Yes	Zoom level. Minimum value is 1.
`x`	path	integer	Yes	Tile column (X coordinate in the XYZ tile grid).
`y`	path	integer	Yes	Tile row (Y coordinate in the XYZ tile grid).
`cache`	query	string	No	Cache strategy to use. Default: active. One of: `active`, `seeding`.
`rerender`	query	string	No	Forces the tile to be deleted from the cache and re-rendered. One of: `true`.

Status Description

200 PNG tile image.

Status	Description
`200`	PNG tile image.
`400`	Bad request. Rendering errors `Tile cannot be rendered` — the map renderer failed to produce the tile. Style initialization error message forwarded as-is.
`404`	Tile not found. Known messages `Rastertiles start at zoomlevel 1` — zoom level 0 is not supported. `Tile does not exist` — tile is outside the style’s coverage area.

400

Bad request.

Rendering errors

Tile cannot be rendered — the map renderer failed to produce the tile.
Style initialization error message forwarded as-is.

404

Tile not found.

Known messages

Rastertiles start at zoomlevel 1 — zoom level 0 is not supported.
Tile does not exist — tile is outside the style’s coverage area.

Try it

The console below sends live requests against the endpoints above. You can browse it without an API key; Execute needs one, because every endpoint requires the api_key query parameter and returns 403 without it. Use Authorize to add your key. See First Steps if you do not have one yet.