BuildingsAccess
baseUrlBuildings CDN origin to prepend to tileset paths.
countriesCountries with 3D-building coverage (ISO 3166-1 alpha-2). The
tileset for a country lives at {baseUrl}/{CC}/tileset.json.
expiresAtUnix timestamp (seconds) when the signature expires.
querySigned query string — append after ? on any tileset artifact URL.
Costing
Routing profile. auto (car), bicycle, or pedestrian (foot).
ElevationPoint
latlonelevationElevation in metres above sea level, or null where there is no
coverage (e.g. open ocean).
ElevationRequest
encodedPolylineA route as a single encoded polyline (precision 6). The server samples
it at samples evenly-spaced points — send a whole GPS track this way
rather than thousands of individual points.
Up to 512 discrete (lat, lon) points to look up. Omit when using
encodedPolyline.
samplesNumber of evenly-spaced samples for encodedPolyline mode. Default
256, capped at 1000.
ElevationResponse
ErrorResponse
errorMachine-readable error code, e.g. quota_exhausted.
messageHuman-readable explanation.
IsochroneContour
colorHex color without leading hash.
distancetimeIsochroneFeature
geometryGeoJSON geometry — Polygon or LineString depending on the polygons flag.
typeIsochroneRequest
One contour per reachable-area band. The product
len(locations) × len(contours) must not exceed 4.
costingRouting profile. auto (car), bicycle, or pedestrian (foot).
polygonsReturn polygons instead of GeoJSON LineStrings.
IsochroneResponse
typeLngLat
latlonMapMatchingRequest
costingRouting profile. auto (car), bicycle, or pedestrian (foot).
encodedPolylineThe GPS trace as a single encoded polyline (precision 6). An
alternative to shape for compact transport of long traces.
The GPS trace as ordered (lat, lon) points. Capped at 100 points;
use encodedPolyline for longer traces. Omit when using
encodedPolyline.
shapeMatchHow aggressively to snap to roads. map_snap (default) matches to
the road network; walk_or_snap and edge_walk trade accuracy for
speed on dense traces.
MatrixCell
fromIndextoIndexdistanceDistance in the requested units. null if the pair is unreachable.
timeTravel time in seconds. null if the pair is unreachable.
MatrixResponse
unitsOptimizedRouteRequest
costingRouting profile. auto (car), bicycle, or pedestrian (foot).
Two or more waypoints. The first is the start and the last is the end; the intermediate stops are reordered for the shortest total trip. Capped at 20 locations.
PlaceFeature
Geographic metadata for a place. Optional fields are omitted when the underlying record doesn't carry them — e.g. a country-level result has no street.
typeFixed string "Feature".
PlaceFeatureCollection
typePlaceProperties
citycountrycountrycodeISO 3166-1 alpha-2 country code.
nameDisplay name of the place.
postcodestatestreettypeWhat kind of place this is — street, house, locality, city,
district, region, country, etc.
RouteLeg
shapeEncoded polyline at 1e-6 precision (the standard Google polyline
algorithm with 6 decimals instead of 5). Decoders are available for
every major language — in JavaScript, @mapbox/polyline with the
precision set to 6 returns [lat, lon] pairs.
RouteManeuver
beginShapeIndexendShapeIndexinstructionlengthtimeRouteResponse
RouteSummary
lengthTotal length in the requested units.
timeTotal travel time in seconds.
maxLatmaxLonminLatminLonSignedTileUrl
Access descriptor for the 3D-buildings tilesets. Always included —
rendering 3D buildings is part of the same tile session, so it adds
no quota cost. Compose the per-country tileset URL as
{baseUrl}/{CC}/tileset.json?{query} and append the same query to
every tile it references. Refresh together with the tile URLs.
expiresAtUnix timestamp (seconds) when the signature expires.
terrainUrlSigned URL for the optional terrain (elevation) archive — feed it to a
MapLibre raster-dem source with encoding: "terrarium" for hillshade
or 3D terrain. Shares this session's expiry; refresh both together.
Rendering terrain is part of the same tile session, so it adds no quota
cost.
urlSigned URL ready to feed to MapLibre's pmtiles:// protocol handler.
satelliteBaseUrlSigned URL for the global base imagery archive (raster, z0–7) — ocean bathymetry and polar ice. Layer it BELOW the satellite source: the satellite mosaic covers land only, so this is what fills open water and the poles. Same session, no extra quota cost.
satelliteBesUrlSigned URL for the Caribbean Netherlands aerial archive (raster, z13–21). A separate source from the mainland one — it reaches a deeper zoom — layered the same way. Same session, no extra quota cost.
satelliteNlUrlSigned URL for the high-resolution Netherlands aerial archive (raster, z13–17) — layer it above the global satellite source. Same session, no extra quota cost.
satelliteOceanUrlSigned URL for the water-only overlay (raster, z0–7). Draw it ABOVE the satellite source and fade it out past ~z9: the satellite mosaic covers water poorly, so this renders the sea instead. Same session, no extra quota cost.
satelliteUrlSigned URL for the global satellite imagery archive (raster, z0–13).
Feed it to a MapLibre raster source for the Satellite / Hybrid
styles. Present once satellite imagery is available on the account's
region; rendering it is part of the same tile session, so it adds no
quota cost. Refresh together with the tile URLs.
TrafficAccess
baseUrlTraffic CDN origin to prepend to artifact paths.
countriesCountries included in this grant (ISO 3166-1 alpha-2).
expiresAtUnix timestamp (seconds) when the signature expires.
querySigned query string — append after ? on any artifact URL.
Trip
languagestatusstatusMessageunits