Skip to main content
POST
maps.image.render

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
theme
enum<string>
default:streets

Public map theme.

Available options:
streets,
outdoors,
light,
dark,
satellite,
satellite-streets
center
object

Map center.

zoom
number

Map zoom, required with center.

Required range: 0 <= x <= 22
bounds
tuple

West, south, east, north extent.

auto
boolean
default:false

Fit the map to overlays.

width
integer
default:600

Logical image width, up to 1280.

Required range: 1 <= x <= 1280
height
integer
default:400

Logical image height, up to 1280.

Required range: 1 <= x <= 1280
scale
default:1

Pixel scale.

format
enum<string>
default:png

Image format.

Available options:
png,
jpeg,
webp
bearing
number
default:0

Map rotation.

Required range: 0 <= x <= 360
pitch
number
default:0

Map tilt.

Required range: 0 <= x <= 60
padding
integer[]

Padding for fitted bounds: top, right, bottom, left.

Required array length: 1 - 4 elements
Required range: 0 <= x <= 1280
markers
object[]

Map markers.

Maximum array length: 20
paths
object[]

Paths drawn on the map.

Maximum array length: 5
features
object[]

Geographic overlays; may contain private coordinates and text.

Maximum array length: 20
beforeLayer
string

Draw overlays before this public style layer.

Pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,63}$
addLayer
object

Add a drawing layer using public geographic data.

filter
object

Equality filter on one public layer.

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