Schemas

Language for narrative directions.

Elevation in metres above sea level, or null where there is no coverage (e.g. open ocean).

A 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.

Number of evenly-spaced samples for encodedPolyline mode. Default 256, capped at 1000.

Machine-readable error code, e.g. quota_exhausted.

Human-readable explanation.

Hex color without leading hash.

GeoJSON geometry — Polygon or LineString depending on the polygons flag.

One contour per reachable-area band. The product len(locations) × len(contours) must not exceed 4.

Routing profile. auto (car), bicycle, or pedestrian (foot).

Return polygons instead of GeoJSON LineStrings.

Routing profile. auto (car), bicycle, or pedestrian (foot).

The 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.

How 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.

Distance in the requested units. null if the pair is unreachable.

Travel time in seconds. null if the pair is unreachable.

Routing profile. auto (car), bicycle, or pedestrian (foot).

Routing 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.

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.

Fixed string "Feature".

ISO 3166-1 alpha-2 country code.

Display name of the place.

What kind of place this is — street, house, locality, city, district, region, country, etc.

[lon, lat].

Fixed string "Point".

Encoded 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.

Routing profile. auto (car), bicycle, or pedestrian (foot).

Two or more ordered waypoints. The first is the origin, the last is the destination.

Total length in the requested units.

Total travel time in seconds.

Unix timestamp (seconds) when the signature expires.

Signed 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.

Signed URL ready to feed to MapLibre's pmtiles:// protocol handler.