Skip to main content
POST
maps.tile.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
zoom
integer
required

Tile zoom.

Required range: 0 <= x <= 22
x
integer
required

Tile column.

Required range: 0 <= x <= 9007199254740991
y
integer
required

Tile row.

Required range: 0 <= x <= 9007199254740991
dataset
enum<string>

Public image dataset; elevation uses terrain RGB encoding.

Available options:
satellite,
elevation
theme
enum<string>

Public map theme.

Available options:
streets,
outdoors,
light,
dark,
satellite,
satellite-streets
scale
default:1

Image pixel scale.

tileSize
default:512

Theme tile size; public raster datasets use 256 logical pixels.

format
enum<string>
default:png

Image format; elevation requires PNG.

Available options:
png,
jpeg

Response

The result

file
object
required

Image on your file storage.

width
integer
required

Image width in pixels.

Required range: x <= 9007199254740991
height
integer
required

Image height in pixels.

Required range: x <= 9007199254740991