Skip to main content
GET
Get the project map state

Authorizations

Authorization
string
header
required

Personal API key (mkx_...) created from the MapX account.

Path Parameters

id
string
required

Project UUID.

Response

Current map state (center, zoom, bearing, pitch, basemap).

Current map viewport and basemap state.

center
number[]

Map center as [lng, lat].

Required array length: 2 elements
zoom
number

Map zoom level, 0-22.

Required range: 0 <= x <= 22
bearing
number

Map rotation in degrees.

pitch
number

Map pitch in degrees, 0-85.

Required range: 0 <= x <= 85
basemap
object

Basemap style and per-category overrides.

countryMask
object | null

Inverted-polygon mask that hides the basemap outside a country. Omitted or null means no country mask.

customMask
object | null

Custom polygon mask built from arbitrary GeoJSON. Omitted or null means no custom mask.