v1

latestOpenAPI 3.1.02026-08-0420183200.9 KB

Routing

Get turn by turn routing instructions between two or more locations.

The route (turn-by-turn) API computes routes between two or more locations. It supports a variety of tunable costing methods, and supports routing through intermediate waypoints and discontinuous multi-leg routes.

post/route/v1

Request body

idstring

An identifier to disambiguate requests (echoed by the server).

A routing profile that determines which roads you can access, and how desirable they are based on the type of travel and other parameters. Profiles with a _traffic suffix use heuristically-selected traffic data sources to improve ETA and time-dependent route quality while balancing the credit cost. The _traffic_premium profiles leverage multiple types of data for maximum accuracy. Traffic-influenced profiles use the same costing options as their base profile (e.g., use the auto key in costing_options for auto_traffic).

alternatesinteger

How many alternate routes are desired. Note that fewer or no alternates may be returned. Alternates are not yet supported on routes with more than 2 locations or on time-dependent routes.

elevation_intervalnumber float

If greater than zero, attempts to include elevation along the route at regular intervals. The "native" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter. Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn't always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the routing endpoints and is not available via the elevation API. NOTE: This has no effect on the OSRM response format.

roundabout_exitsboolean

Determines whether the output should include roundabout exit instructions.

units'km' | 'mi'

directions_type'none' | 'maneuvers' | 'instructions'

The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter.

format'json' | 'osrm'

The output response format. The default JSON format is extremely compact and ideal for web or data-constrained use cases where you want to fetch additional attributes on demand in small chunks. The OSRM format is much richer and is configurable with significantly more info for turn-by-turn navigation use cases.

banner_instructionsboolean

Optionally includes helpful banners with timing information for turn-by-turn navigation. This is only available in the OSRM format.

voice_instructionsboolean

Optionally includes voice instructions with timing information for turn-by-turn navigation. This is only available in the OSRM format.

Example request

{
  "costing": "auto_traffic",
  "costing_options": {
    "auto": {
      "use_highways": 0,
      "use_tolls": 1
    }
  },
  "date_time": {
    "type": 1,
    "value": "2025-07-03T08:06"
  },
  "locations": [
    {
      "lat": 60.5347155,
      "lon": -149.543469,
      "type": "break"
    },
    {
      "lat": 60.5349908,
      "lon": -149.5485806,
      "type": "break"
    }
  ],
  "units": "miles"
}

Response

The computed route(s).

Example response

{
  "trip": {
    "language": "en-US",
    "legs": [
      {
        "maneuvers": [
          {
            "begin_shape_index": 0,
            "cost": 15.508,
            "end_shape_index": 9,
            "instruction": "Drive west on AK 1/Seward Highway.",
            "length": 0.176,
            "street_names": [
              "AK 1",
              "Seward Highway"
            ],
            "time": 11.487,
            "travel_mode": "drive",
            "travel_type": "car",
            "type": 1,
            "verbal_multi_cue": true,
            "verbal_post_transition_instruction": "Continue for 900 feet.",
            "verbal_pre_transition_instruction": "Drive west on Alaska 1, Seward Highway. Then You will arrive at your destination."
          },
          {
            "begin_shape_index": 9,
            "cost": 0,
            "end_shape_index": 9,
            "instruction": "You have arrived at your destination.",
            "length": 0,
            "time": 0,
            "travel_mode": "drive",
            "travel_type": "car",
            "type": 4,
            "verbal_pre_transition_instruction": "You have arrived at your destination.",
            "verbal_transition_alert_instruction": "You will arrive at your destination."
          }
        ],
        "shape": "wzvmrBxalf|GcCrX}A|Nu@jI}@pMkBtZ{@x^_Afj@Inn@`@veB",
        "summary": {
          "cost": 15.508,
          "has_time_restrictions": false,
          "length": 0.176,
          "max_lat": 60.535008,
          "max_lon": -149.543469,
          "min_lat": 60.534715,
          "min_lon": -149.54858,
          "time": 11.487
        }
      }
    ],
    "locations": [
      {
        "lat": 60.534715,
        "lon": -149.543469,
        "original_index": 0,
        "type": "break"
      },
      {
        "lat": 60.53499,
        "lon": -149.54858,
        "original_index": 1,
        "type": "break"
      }
    ],
    "status": 0,
    "status_message": "Found route between points",
    "summary": {
      "cost": 15.508,
      "has_time_restrictions": false,
      "length": 0.176,
      "max_lat": 60.535008,
      "max_lon": -149.543469,
      "min_lat": 60.534715,
      "min_lon": -149.54858,
      "time": 11.487
    },
    "units": "miles"
  }
}