clearance

Measured overhead clearance along a route shape (see module docs).

post/v1/clearance/along

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/v1/clearance/along
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Request body

datasetsstring[] nullable

Narrow the search to these datasets. The default is every dataset this key may see whose survey covers the corridor. A name this key may not see, or that does not exist, is dropped: the answer is the same "not surveyed" either way.

geometry_polyline6string required

The corridor as a Google encoded polyline, six-digit precision, typically geometry_polyline6 from a prior /route response. Capped at 10,000 vertices.

include_station_geometryboolean

Fill every section's deprecated polyline array with the raw station positions ([lng, lat], one per 0.5 m station) instead of the simplified points polyline6 encodes. Off by default: on a whole-route "not surveyed" run the raw array is megabytes.

margin_mnumber double

The caller's operating margin in metres, added to the height. Defaults to zero, and is echoed back: no compliance policy is baked in here, both figures are reported.

vehicle_height_mnumber double required

Vehicle height in metres. Required: there is no default vehicle.

vehicle_width_mnumber double nullable

Vehicle width in metres. The width axis is assessed only when this is given; without it the report answers for height and says so.

Response

The clearance report: verdict per axis, limiting point with its bound, coverage, datasets read

basisstring required

Always surveyed_geometry_not_signage.

explanationstring required

One-line honest summary. British English, no claim words, no em dashes; see explain.rs, which enforces that rather than asking.

Changes

No recorded changes to this operation across all 1 revision of this API.