mapbox-compat

Mapbox-compatible Directions (see module docs). Metered exactly as `GET /route/v1`: one unit per started block of 20 waypoints, premium on the `truck` profile.

get/directions/v5/{user}/{profile}/{coordinates}

Request

  • Base URL: https://api.mapmap.ai
  • URL: https://api.mapmap.ai/directions/v5/{user}/{profile}/{coordinates}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_key

Path parameters

userstring required

mapbox or mapmap

profilestring required

driving, driving-traffic (served as driving: traffic-aware times cover the England strategic road network only), walking, cycling or truck (MapMap extension, premium)

coordinatesstring required

lon,lat pairs separated by ;

Query parameters

access_tokenstring

Your MapMap key (snk_...), accepted here as Mapbox clients send it; api_key and a bearer header work too

alternativesboolean

Return up to three alternative routes

annotationsstring

Comma-separated: distance, duration, speed (each manoeuvre's engine length and time spread over its segments by length) and maxspeed. congestion, congestion_numeric, closure and state_of_charge are refused with a 400 naming the supported set

geometriesstring

polyline (default), polyline6 or geojson

overviewstring

simplified (default), full or false

stepsboolean

Turn-by-turn steps

languagestring

BCP 47 instruction language

voice_instructionsboolean

Mapbox-shaped voiceInstructions on each step (metric units)

banner_instructionsboolean

Mapbox-shaped bannerInstructions on each step

excludestring

toll, motorway, ferry, tunnel: hard exclusions, so an unavoidable one answers NoRoute where Mapbox would return a violating route

depart_atstring

Local departure time, YYYY-MM-DDThh:mm

approachesstring

curb or unrestricted per coordinate, ; separated

Response

Mapbox Directions response: code, routes (each with weight_name: "duration"), waypoints and uuid (the request id). NoRoute and NoSegment also answer 200 with that code and empty routes, as Mapbox documents

object required

Changes

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