Directions | API

Directions API version

This documentation is for v5 of the Directions API. For information about the earlier version, see the v4 documentation or view the changelog.

The Mapbox Directions API will show you how to get where you're going. With the Directions API, you can:

Calculate optimal driving, walking, and cycling routes using traffic- and incident-aware routing
Produce turn-by-turn instructions
Produce routes with up to 25 coordinates for the driving, driving-traffic, walking, and cycling profiles
Calculate routes for electric vehicles to reach destinations with optimal charging stops as well as battery prediction

playground

Directions API playground

Retrieve directions between waypoints and see the results on a map.

tutorial

Directions API tutorials

To see all tutorials related to the Directions API, use the Products filter on our Tutorials page.

Routing profiles

The Directions API supports 4 different routing profiles:

Profile	Description
`mapbox/driving-traffic`	For automotive routing. This profile factors in current and historic traffic conditions to avoid slowdowns. Traffic information is available for the supported geographies listed in our Traffic Data page. Requests using this profile accept up to 25 coordinates.
`mapbox/driving`	For automotive routing. This profile shows the fastest routes by preferring high-speed roads like highways. Requests using this profile accept up to 25 coordinates.
`mapbox/walking`	For pedestrian and hiking routing. This profile shows the shortest path by using sidewalks and trails. Requests using this profile accept up to 25 coordinates.
`mapbox/cycling`	For bicycle routing. This profile shows routes that are short and safer for cyclists by avoiding highways and preferring streets with bike lanes. Requests using this profile accept up to 25 coordinates.

Retrieve directions

get

https://api.mapbox.com/directions/v5/{profile}/{coordinates}

Required parameters

Retrieve directions between waypoints. Directions requests must specify at least two waypoints as starting and ending points.

Required parameters	Type	Description
`profile`	string	The routing profile to use. Possible values are `mapbox/driving-traffic`, `mapbox/driving`, `mapbox/walking`, or `mapbox/cycling`.
`coordinates`	number	A semicolon-separated list of between two and 25 `{longitude},{latitude}` coordinate pairs to visit in order.

Optional parameters

You can further refine the results from this endpoint with the following optional parameters:

Optional parameters Type Description

alternatives boolean Whether to try to return alternative routes (true) or not (false, default). An alternative route is a route that is significantly different from the fastest route, but also still reasonably fast. Such a route does not exist in all circumstances. Up to two alternatives may be returned. This is available for mapbox/driving-traffic, mapbox/driving, mapbox/cycling and mapbox/walking.

annotations

string

Return additional metadata along the route. You can include several annotations as a comma-separated list. Must be used in conjunction with overview=full.

Possible values	Description
`distance`	The distance between each pair of coordinates, in meters.
`duration`	The duration between each pair of coordinates, in seconds.
`speed`	The speed between each pair of coordinates, in meters per second.
`congestion`	The level of congestion between each entry in the array of coordinate pairs in the route leg. This annotation is only available for the `mapbox/driving-traffic` profile.
`congestion_numeric`	The numeric level of congestion between each entry in the array of coordinate pairs in the route leg. This annotation is only available for the `mapbox/driving-traffic` profile.
`maxspeed`	The maximum speed limit between the coordinates of a segment. This annotation is only available for the `mapbox/driving` and `mapbox/driving-traffic` profiles.
`closure`	An array of closure objects describing live-traffic related closures that occur along the route. This annotation is only available for the `mapbox/driving-traffic` profile.
`state_of_charge` Beta	The battery state of charge, a value between 0 and 100. Only available for EV-routing.

See the route leg object for more details on what is included with annotations.

avoid_maneuver_radius number Add a radius around the starting point in which the API will avoid returning any significant maneuvers. Possible values are in the range from 0 to 1000 meters. Use this option when the vehicle is traveling at a significant speed to avoid dangerous maneuvers when re-routing. If a route is not found using the specified value, it will be ignored. Note that if a large radius is used, the API may ignore an important turn and return a long straight path before the first maneuver. The avoid_maneuver_radius parameter cannot be used with the arrive_by=<time> or depart_at=<time> options, since these modes are used for reference requests, not for real-time routing. But you can use the depart_at=now option. This is available for mapbox/driving-traffic and mapbox/driving.

bearings integer Influences the direction in which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on by direction. This is useful for making sure the new routes of rerouted vehicles continue traveling in their current direction. A request that does this would provide bearing and radius values for the first waypoint and leave the remaining values empty. Takes two comma-separated values per waypoint: an angle clockwise from true north between 0 and 360, and the range of degrees by which the angle can deviate (recommended value is 45° or 90°), formatted as {angle, degrees}. If provided, the list of bearings must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the ; separator.

layers integer Influences the layer of road from which a route starts from a waypoint. Used to filter the road segment the waypoint will be placed on, in Z-order. This is useful to avoid ambiguity in the case of multi-level roads (for example, a tunnel under a road). Takes a single signed integer per waypoint. If provided, the list of layers must be the same length as the list of coordinates. However, you can skip a coordinate and show its position in the list with the ; separator. Corresponds to the layer field in Mapbox Streets v8. Note that if a matching layer is not found, the API will choose a suitable layer according to other provided parameters.

continue_straight boolean Sets the allowed direction of travel when departing intermediate waypoints. If true, the route will continue in the same direction of travel. If false, the route may continue in the opposite direction of travel. Defaults to true for mapbox/driving and false for mapbox/walking and mapbox/cycling.

exclude

string

Exclude certain road types and custom locations from routing. Default is to not exclude anything from the list below. You can specify multiple values as a comma-separated list. The following exclude values are available:

Possible values	Description
`motorway`	Exclude highways or motorways. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.
`toll`	Exclude roads with tolls. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.
`ferry`	Exclude ferry rides across waterways. Available in `mapbox/driving`, `mapbox/driving-traffic`, `mapbox/cycling` and `mapbox/walking` profiles.
`unpaved`	Exclude dirt roads or track. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.
`cash_only_tolls`	Exclude roads with tolls that accept only cash. Available in `mapbox/driving`, `mapbox/driving-traffic`, `mapbox/walking` and `mapbox/cycling` profiles.
`point(longitude latitude)` Beta	Exclude custom locations such as dangerous entry/exit points, bridges, tunnels, low quality roads and cross border roads. Coordinate specified in WKT format will be snapped to the nearest road and the snapped coordinate will be excluded from routing. You can specify multiple coordinates with a comma-separated list. Eg. point(lon1 lat1), point(lon2 lat2). Note that at most 50 points are allowed per API request. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.

geometries string The format of the returned geometry. Allowed values are: geojson (as LineString), polyline (default, a polyline with a precision of five decimal places), polyline6 (a polyline with a precision of six decimal places).

include

string

Include certain additional road types for routing. The default is to not include these road types. You can specify multiple values as a comma-separated list. The following include values are available:

Possible values	Description
`hov2`	A road type that requires a minimum of two vehicle occupants. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.
`hov3`	A road type that requires a minimum of three vehicle occupants. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.
`hot`	An hov road that is tolled if your vehicle doesn't meet the minimum occupant requirement. Available in `mapbox/driving` and `mapbox/driving-traffic` profiles.

overview string Displays the requested type of overview geometry. Can be full (the most detailed geometry available), simplified (default, a simplified version of the full geometry), or false (no overview geometry).

radiuses number or string The maximum distance a coordinate can be moved to snap to the road network, in meters. There must be as many radiuses as there are coordinates in the request, each separated by ;. Values can be any number greater than 0 or the string unlimited. A NoSegment error is returned if no routable road is found within the radius.

approaches string A semicolon-separated list indicating the side of the road from which to approach waypoints in a requested route. Accepts unrestricted (default, route can arrive at the waypoint from either side of the road) or curb (route will arrive at the waypoint on the driving_side of the region). If provided, the number of approaches must be the same as the number of waypoints. However, you can skip a coordinate and show its position in the list with the ; separator. Since the first value will not be evaluated, begin the list with a semicolon. If the waypoint is within 1 meter of the road, this parameter is ignored.

steps boolean Whether to return steps and turn-by-turn instructions (true) or not (false, default).

If steps is set to true, the following guidance-related parameters will be available: banner_instructions, language, roundabout_exits, voice_instructions, voice_units, waypoint_names, waypoint_targets, and waypoints.

banner_instructions boolean Whether to return banner objects associated with the route steps (true) or not (false, default). Must be used in conjunction with steps=true.

language string The language of returned turn-by-turn text instructions. See supported languages. The default is en (English). Must be used in conjunction with steps=true.

roundabout_exits boolean Whether to emit instructions at roundabout exits (true) or not (false, default). Without this parameter, roundabout maneuvers are given as a single instruction that includes both entering and exiting the roundabout. With roundabout_exits=true, this maneuver becomes two instructions, one for entering the roundabout and one for exiting it. Must be used in conjunction with steps=true.

voice_instructions boolean Whether to return SSML marked-up text for voice guidance along the route (true) or not (false, default). Must be used in conjunction with steps=true.

voice_units string Specify which type of units to return in the text for voice instructions. Can be imperial (default) or metric. Must be used in conjunction with steps=true and voice_instructions=true.

waypoint_names string A semicolon-separated list of custom names for entries in the list of coordinates, used for the arrival instruction in banners and voice instructions. Values can be any string, and the total number of all characters cannot exceed 500. If provided, the list of waypoint_names must be the same length as the list of waypoints, but you can skip a waypoint coordinate and show its position in the list with the ; separator. The first value in the list corresponds to the route origin, not the first destination. To leave the origin unnamed, begin the list with a semicolon. Must be used in conjunction with steps=true.

waypoint_targets number A semicolon-separated list of coordinate pairs used to specify drop-off locations that are distinct from the locations specified in coordinates. If this parameter is provided, the Directions API will compute the side of the street, left or right, for each target based on the waypoint_targets and the driving direction. The maneuver.modifier, banner and voice instructions will be updated with the computed side of street. The number of waypoint_targets must be the same as the number of waypoints, but you can skip a waypoint coordinate and show its position in the list with the ; separator. Since the first value will not be evaluated, begin the list with a semicolon. Must be used in conjunction with steps=true.

waypoints integer A semicolon-separated list indicating which input coordinates should be treated as waypoints. Waypoints form the beginning and end of each leg in the returned route, and when the steps=true parameter is used, correspond to the depart and arrive steps. If a list of waypoints is not provided, all coordinates are treated as waypoints. Each item in the list must be the zero-based index of an input coordinate, and the list must include 0 (the index of the first coordinate) and the index of the last coordinate. The waypoints parameter can be used to guide the path of the route without introducing additional legs and arrive/depart instructions. Must be used in conjunction with steps=true.

Optional parameters for the `mapbox/walking` profile

Optional `v5/mapbox/walking` parameters	Type	Description
`walking_speed`	number	The walking speed, in meters per second, with a minimum of `0.14` m/s (or `0.5` km/h) and a maximum of `6.94` m/s (or `25.0` km/h). Defaults to `1.42` m/s (`5.1` km/h).
`walkway_bias`	number	A scale from `-1` to `1`, where `-1` biases the route against walkways and `1` biases the route toward walkways. The default is `0`, which is neutral.

Unrecognized options in the query string result in an InvalidInput error.

Optional parameters for the `mapbox/driving` profile

Optional `v5/mapbox/driving` parameters	Type	Description
`alley_bias`	number	A scale from `-1` to `1`, where `-1` biases the route against alleys and `1` biases the route toward alleys. The default is `0`, which is neutral.
`arrive_by`	string	The desired arrival time, formatted as a timestamp in ISO-8601 format in the local time at the route destination. The travel time, returned in `duration`, is a prediction for travel time based on historical travel data. The route is calculated in a time-dependent manner. For example, a trip that takes two hours will consider changing historic traffic conditions across the two-hour window. The route takes timed turn restrictions and conditional access restrictions into account based on the requested arrival time.
`depart_at`	string	The departure time, formatted as a timestamp in ISO-8601 format in the local time at the route origin. The travel time, returned in `duration`, is a prediction for travel time based on historical travel data. The route is calculated in a time-dependent manner. For example, a trip that takes two hours will consider changing historic traffic conditions across the two-hour window, instead of only at the specified `depart_at` time. The route takes timed turn restrictions and conditional access restrictions into account based on the requested departure time.
`use_current_time`	bool	The departure time is set to be the current time. The travel time, returned in `duration`, is a prediction for travel time based on historical travel data. The route is calculated in a time-dependent manner. For example, a trip that takes two hours will consider changing historic traffic conditions across the two-hour window, instead of only at the current time.
`max_height`	number	The max vehicle height, in meters. If this parameter is provided, the Directions API will compute a route that includes only roads with a height limit greater than or equal to the max vehicle height. `max_height` must be between 0 and 10 meters. The default value is 1.6 meters. Coverage for road height restriction may vary by region.
`max_width`	number	The max vehicle width, in meters. If this parameter is provided, the Directions API will compute a route that includes only roads with a width limit greater than or equal to the max vehicle width. `max_width` must be between 0 and 10 meters. The default value is 1.9 meters. Coverage for road width restriction may vary by region.
`max_weight`	number	The max vehicle weight, in metric tons (1000 kg). If this parameter is provided, the Directions API will compute a route that includes only roads with a weight limit greater than or equal to the max vehicle weight. `max_weight` must be between 0 and 100 metric tons. The default value is 2.5 metric tons. Coverage for road weight restriction may vary by region.

Optional parameters for the `mapbox/driving-traffic` profile

Optional `v5/mapbox/driving-traffic` parameters	Type	Description
`depart_at`	string	The departure time, formatted as a timestamp in ISO-8601 format in the local time at the route origin. The travel time, returned in `duration`, is a prediction for travel time based on historical travel data and live traffic. Live traffic is gently mixed with historical data when `depart_at` is set close to current time. The route takes timed turn restrictions and conditional access restrictions into account based on the requested arrival time.
`use_current_time`	bool	The departure time is set to be the current time. The travel time, returned in `duration`, is a prediction for travel time based on historical travel data and live traffic. Live traffic is gently mixed with historical data. The route takes timed turn restrictions and conditional access restrictions into account based on the requested arrival time.
`snapping_include_closures`	boolean	A semicolon-separated list of booleans affecting snapping of coordinate locations to road segments. If `true`, road segments closed due to live-traffic closures will be considered for snapping. If `false`, they will not be considered for snapping. If provided, the number of `snapping_include_closures` must be the same as the number of coordinates. However, you can skip a coordinate and show its position in the list with the `;` separator. If unspecified, this paramter defaults to `false`.
`snapping_include_static_closures`	boolean	A semicolon-separated list of booleans affecting snapping of coordinate locations to road segments. If `true`, road segments statically closed, that is long-term, will be considered for snapping (for example, road under construction). If `false`, they will not be considered for snapping. If provided, the number of `snapping_include_static_closures` must be the same as the number of coordinates. However, you can skip a coordinate and show its position in the list with the `;` separator. If unspecified, this paramter defaults to `false`.
`max_height`	number	The max vehicle height, in meters. If this parameter is provided, the Directions API will compute a route that includes only roads with a height limit greater than or equal to the max vehicle height. `max_height` must be between 0 and 10 meters. The default value is 1.6 meters. Coverage for road height restriction may vary by region.
`max_width`	number	The max vehicle width, in meters. If this parameter is provided, the Directions API will compute a route that includes only roads with a width limit greater than or equal to the max vehicle width. `max_width` must be between 0 and 10 meters. The default value is 1.9 meters. Coverage for road width restriction may vary by region.
`max_weight`	number	The max vehicle weight, in metric tons (1000 kg). If this parameter is provided, the Directions API will compute a route that includes only roads with a weight limit greater than or equal to the max vehicle weight. `max_weight` must be between 0 and 100 metric tons. The default value is 2.5 metric tons. Coverage for road weight restriction may vary by region.

Example requests: Retrieve directions

# Request directions with no additional options

$ curl "https://api.mapbox.com/directions/v5/mapbox/cycling/-122.42,37.78;-77.03,38.91?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Request to access speed limit information using the maxspeed annotation
$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/-122.39636,37.79129;-122.39732,37.79283;-122.39606,37.79349?annotations=maxspeed&overview=full&geometries=geojson&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Request directions with radiuses and a polyline6 response through multiple waypoints

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.41,52.5?radiuses=40;;100&geometries=polyline6&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Specify bearings and radiuses

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.43,52.5?bearings=60,45;;45,45&radiuses=100;100;100&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Assign layers to waypoints, to handle ambiguities in the case of multi-level roads

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.43,52.5?layers=-1;;3&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Request a route that approaches the destination on the curb of the driving side

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.43,52.5?approaches=unrestricted;curb&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Request directions with voice and banner instructions specifying waypoint_names

$ curl "https://api.mapbox.com/directions/v5/mapbox/cycling/-122.42,37.78;-77.03,38.91?steps=true&voice_instructions=true&banner_instructions=true&voice_units=imperial&waypoint_names=Home;Work&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Specify waypoints

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.43,52.5?waypoints=0;2&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# Specify a departure time

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/-122.396112,37.791399;-122.433904,37.757812?access_token=YOUR_MAPBOX_ACCESS_TOKEN&depart_at=2019-05-02T15:00"

Supported libraries: Retrieve directions

Mapbox wrapper libraries help you integrate Mapbox APIs into your existing application. The following SDKs support this endpoint:

See the SDK documentation for details and examples of how to use the relevant methods to query this endpoint.

Response: Retrieve directions

The response to a Directions API request is a JSON object that contains the following properties:

Property	Type	Description
`code`	string	A code indicating the state of the response. This is a different code than the HTTP status code. On normal valid responses, the value will be `Ok`. For other responses, see the Directions API errors table.
`waypoints`	array	An array of waypoint objects. Each waypoint is an input coordinate snapped to the road and path network. The waypoints appear in the array in the order of the input coordinates.
`routes`	array	An array of route objects ordered by descending recommendation rank. The response object may contain at most two routes.

Example response: Retrieve directions

{
  "routes": [
    {
      "geometry": "mnn_Ick}pAfBiF`CzA",
      "legs": [
        {
          "summary": "Köpenicker Straße, Engeldamm",
          "weight": 44.4,
          "duration": 26.2,
          "steps": [
            {
              "intersections": [
                {
                  "out": 0,
                  "entry": [ true ],
                  "bearings": [ 125 ],
                  "location": [ 13.426579, 52.508068 ]
                },
                {
                  "out": 1,
                  "in": 2,
                  "entry": [ true, true, false ],
                  "bearings": [ 30, 120, 300 ],
                  "location": [ 13.426688, 52.508022 ]
                }
              ],
              "driving_side": "right",
              "geometry": "mnn_Ick}pAHUlAqDNa@",
              "mode": "driving",
              "maneuver": {
                "bearing_after": 125,
                "bearing_before": 0,
                "location": [ 13.426579, 52.508068 ],
                "modifier": "right",
                "type": "depart",
                "instruction": "Head southeast on Köpenicker Straße (L 1066)"
              },
              "ref": "L 1066",
              "weight": 35.9,
              "duration": 17.7,
              "name": "Köpenicker Straße (L 1066)",
              "distance": 98.1,
              "voiceInstructions": [
                {
                  "distanceAlongGeometry": 98.1,
                  "announcement": "Head southeast on Köpenicker Straße (L 1066), then turn right onto Engeldamm",
                  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Head southeast on Köpenicker Straße (L <say-as interpret-as=\"address\">1066</say-as>), then turn right onto Engeldamm</prosody></amazon:effect></speak>"
                },
                {
                  "distanceAlongGeometry": 83.1,
                  "announcement": "Turn right onto Engeldamm, then you will arrive at your destination",
                  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Turn right onto Engeldamm, then you will arrive at your destination</prosody></amazon:effect></speak>"
                }
              ],
              "bannerInstructions": [
                {
                  "distanceAlongGeometry": 98.1,
                  "primary": {
                    "text": "Engeldamm",
                    "components": [ { "text": "Engeldamm" } ],
                    "type": "turn",
                    "modifier": "right"
                  },
                  "secondary": null,
                  "sub": null
                }
              ]
            },
            {
              "intersections": [
                {
                  "out": 2,
                  "in": 3,
                  "entry": [ false, true, true, false ],
                  "bearings": [ 30, 120, 210, 300 ],
                  "location": [ 13.427752, 52.50755 ]
                }
              ],
              "driving_side": "right",
              "geometry": "ekn_Imr}pARL\\T^RHDd@\\",
              "mode": "driving",
              "maneuver": {
                "bearing_after": 202,
                "bearing_before": 125,
                "location": [ 13.427752, 52.50755 ],
                "modifier": "right",
                "type": "turn",
                "instruction": "Turn right onto Engeldamm"
              },
              "weight": 8.5,
              "duration": 8.5,
              "name": "Engeldamm",
              "distance": 78.6,
              "voiceInstructions": [
                {
                  "distanceAlongGeometry": 27.7,
                  "announcement": "You have arrived at your destination",
                  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">You have arrived at your destination</prosody></amazon:effect></speak>"
                }
              ],
              "bannerInstructions": [
                {
                  "distanceAlongGeometry": 78.6,
                  "primary": {
                    "text": "You will arrive at your destination",
                    "components": [ { "text": "You will arrive at your destination" } ],
                    "type": "arrive",
                    "modifier": "straight"
                  },
                  "secondary": {
                    "text": "Engeldamm",
                    "components": [ { "text": "Engeldamm" } ],
                    "type": "arrive",
                    "modifier": "straight"
                  }
                },
                {
                  "distanceAlongGeometry": 15,
                  "primary": {
                    "text": "You have arrived at your destination",
                    "components": [ { "text": "You have arrived at your destination" } ],
                    "type": "arrive",
                    "modifier": "straight"
                  },
                  "secondary": {
                    "text": "Engeldamm",
                    "components": [ { "text": "Engeldamm" } ]
                  }
                }
              ]
            },
            {
              "intersections": [
                {
                  "in": 0,
                  "entry": [ true ],
                  "bearings": [ 25 ],
                  "location": [ 13.427292, 52.506902 ]
                }
              ],
              "driving_side": "right",
              "geometry": "cgn_Iqo}pA",
              "mode": "driving",
              "maneuver": {
                "bearing_after": 0,
                "bearing_before": 205,
                "location": [ 13.427292, 52.506902 ],
                "type": "arrive",
                "instruction": "You have arrived at your destination"
              },
              "weight": 0,
              "duration": 0,
              "name": "Engeldamm",
              "distance": 0,
              "voiceInstructions": [ ],
              "bannerInstructions": [ ]
            }
          ],
          "distance": 176.7
        }
      ],
      "weight_name": "routability",
      "weight": 44.4,
      "duration": 26.2,
      "distance": 176.7
    }
  ],
  "waypoints": [
    {
      "name": "Köpenicker Straße",
      "location": [ 13.426579, 52.508068 ]
    },
    {
      "name": "Engeldamm",
      "location": [ 13.427292, 52.506902 ]
    }
  ],
  "code": "Ok",
  "uuid": "cjd51uqn5005447p8nte2zc4w"
}

Use HTTP POST to retrieve directions

The Directions API also supports access using the HTTP POST method. HTTP POST should be used for large requests, since the Directions API has a size limit of approximately 8100 bytes on GET request URLs. POST requests are still subject to your account's request size limits.

Learn more about this process in the Using HTTP POST section.

Electric Vehicle Routing

Electric Vehicle Routing Private Preview

The Directions API now supports electric vehicle (EV) routing that includes EV trip planning and battery prediction along the route, making smarter EVs that are easier to use. EV trip planner automatically identifies if charging is needed and if so, adds charging stops along the journey with optimal charge time and charging level for each stop. The charging stops are returned as waypoints with additional metadata in the route response. You can define the characteristics of the electric vehicle by specifying the parameters below.

For pricing and to sign up for the EV Routing Private Preview, contact EV Sales

Parameters for Electric Vehicle Routing

EV routing is available in driving and driving-traffic profiles. Request an EV route by setting the parameter engine=electric; the other parameters apply only when that is set. Customize the EV route with following parameters representing the battery characteristics and vehicle dynamics:

Parameters Type Description

engine string Set to electric to enable electric vehicle routing. If this parameter is not specified, routing will default to non-electric vehicles.

ev_initial_charge integer Optional parameter to specify initial charge of vehicle in Wh (watt-hours) at the beginning of the route. Example value of 10000 denotes initial battery of 10kWh. The default value is equal to ev_max_charge.

ev_max_charge integer Required parameter that defines the maximum possible charge of vehicle in Wh (watt-hours). Example value of 80000 denotes a battery capacity of 80kWh.

ev_connector_types

string

Required parameter that defines the compatible connector-types for the vehicle. The router will select the charging stations compatible with connector-types. Following connector-types are supported:

Possible values	Description
`ccs_combo_type1`	Combined Charging System J-plug with fast charging DC
`ccs_combo_type2`	Combined Charging System Mennekes with fast charging DC
`tesla`	Proprietary connector for tesla vehicles

energy_consumption_curve string Required parameter that specifies in pairs the energy consumption in watt-hours per kilometer at a certain speed in kph. Example value of 0,300;20,160;80,140;120,180 defines for instance 160 watt-hours per kilometer at 20kph.

ev_charging_curve string Required parameter that specifies the maximum battery charging rate (W) at a given charge level (Wh) in a list of pairs. Example value of 0,100000; 40000,70000; 60000,30000; 80000,10000 defines for instance 70kW charging when the battery has 40kWh charge.

ev_unconditioned_charging_curve string Optional parameter that specifies the maximum battery charging rate (W) at a given charge level (Wh) in a list of pairs when the battery is in an unconditioned state (eg: cold). This is used in conjunction with the ev_pre_conditioning_time parameter, as a result both must be supplied when using either optional field. If only one of these parameters is supplied, this is considered an invalid query and will be rejected. An unconditioned battery may affect the charge time, and may impact the ETA as a result. By accounting for an unconditioned battery with the use of ev_unconditioned_charging_curve and ev_pre_conditioning_time a more accurate ETA can be calculated. Example value of 0,50000; 42000,35000; 60000,15000; 80000,5000 defines for instance 35kW charging when the battery has 40kWh charge. If the battery conditioning parameters are not provided, the standard ev_charging_curve is used for calculating charge times.

ev_pre_conditioning_time integer Optional parameter that defines the time in minutes it would take for the vehicle's battery to condition. This is used in conjunction with the ev_unconditioned_charging_curve parameter, as a result both must be supplied when using either optional field. If only one of these parameters is supplied, this is considered an invalid query and will be rejected. An unconditioned battery may affect the charge time, and may impact the ETA as a result. By accounting for an unconditioned battery with the use of ev_unconditioned_charging_curve and ev_pre_conditioning_time a more accurate ETA can be calculated. Example value of 10 denotes it will take 10 minutes for the battery to reach a conditioned state. If the next ev-charging stop occurs within 10 minutes of the estimated drive, the ev_unconditioned_battery_charging_curve is used to estimate charging times at the EV stop. If an ev-charging stop occurs after ev_pre_conditioning_time of driving time has elapsed, it is assumed the battery is conditioned and the standard ev_charging_curve is used to estimate charging times. The minimum ev_pre_conditioning_time value is 0 minutes, the maximum value is 60 minutes. If the battery conditioning parameters are not provided, the standard ev_charging_curve is used for calculating charge times.

ev_max_ac_charging_power integer Optional parameter to specify maximum AC charging power(W) that can be delivered by the onboard vehicle charger. This parameter along with the ev_charging_curve dictates the battery charging rate. For example, when charging at a 16kW AC power outlet, with a vehicle onboard AC converter of 10kW (ev_max_ac_charging_power), router will use max charging power of 10kW. The default value is 14400W.

ev_min_charge_at_destination integer Optional parameter to define the minimum battery charge required at the final route destination (Wh). Example value of 20000 denotes that vehicle will reach destination with at least 20kWh charge. ev_min_charge_at_destination must be between 0 and ev_max_charge. The default value is 10% of ev_max_charge.

ev_min_charge_at_charging_station integer Optional parameter to define the minimum charge when arriving at the charging station (Wh). Example value of 20000 denotes that the vehicle will reach each charging stop with at least 20kWh charge. ev_min_charge_at_charging_station must be between 0 and ev_max_charge. The default value is 10% of ev_max_charge.

auxiliary_consumption integer Optional parameter to define the measure of the continuous power draw of the auxiliary systems in watts (E.G heating or AC). Auxiliary consumption will affect the estimated power consumed during the trip, and may affect routing as a result. Example value of 300 denotes the vehicle's auxiliary systems are drawing 300 watts of power.

Charging station data

The Mapbox EV Routing processes charging stations from Europe and North America and builds a digital graph of interconnected stations. When you make an EV route request, the router will pick up the nearest stations along the route and identify the fastest chargers that are compatible with the driver’s model of EV.

Supported geographies for EV Routing

Mapbox EV Router supports the following geographies for EV trip planning:

United States
Canada
Germany
United Kingdom

Norway
France
Sweden
Italy

Portugal
Spain
Netherlands

Example EV route request

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/11.59838875578771,48.1498484882143;11.646071564986642,48.157168731123306.json?overview=false&engine=electric&ev_initial_charge=600&ev_max_charge=50000&ev_connector_types=ccs_combo_type1,ccs_combo_type2&energy_consumption_curve=0,300;20,160;80,140;120,180&ev_charging_curve=0,100000;40000,70000;60000,30000;80000,10000&ev_min_charge_at_charging_station=1&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Example route response with EV charging stops

{
  "routes": [
    {
      "weight_name": "auto",
      "weight": 729.764,
      "duration": 1371.657958984375,
      "distance": 4575.367,
      "legs": [
        {
          "via_waypoints": [],
          "summary": "Ifflandstraße, B 2R",
          "admins": [
            {
              "iso_3166_1_alpha3": "DEU",
              "iso_3166_1": "DE"
            }
          ],
          "weight": 333.797,
          "duration": 255.738,
          "steps": [],
          "distance": 2262.614
        },
        {
          "via_waypoints": [],
          "summary": "Arabellastraße, Englschalkinger Straße",
          "admins": [
            {
              "iso_3166_1_alpha3": "DEU",
              "iso_3166_1": "DE"
            }
          ],
          "weight": 395.967,
          "duration": 327.92,
          "steps": [],
          "distance": 2312.754
        }
      ]
    }
  ],
  "waypoints": [
    {
      "name": "Ifflandstraße",
      "location": [
        11.59804,
        48.149988
      ],
      "distance": 30.207000732421875,
      "metadata": null
    },
    {
      "name": "Arabellastraße",
      "location": [
        11.617788,
        48.153125
      ],
      "distance": 18.554000854492188,
      "metadata": {
        "type": "charging-station",
        "name": "BayWa Zentrale",
        "charge_time": 788,
        "charge_to": 5369,
        "charge_at_arrival": 250,
        "plug_type": "ccs_combo_type2",
        "power_kw": 150,
        "station_id": "ocm-128831"
      }
    },
    {
      "name": "Barlowstraße",
      "location": [
        11.646591,
        48.156744
      ],
      "distance": 1.1330000162124634,
      "metadata": null
    }
  ],
  "code": "Ok",
  "uuid": "QJuXPALlclx4ciVHn-UPxhqlUD0W7jjiv1tXFH_haUpp_VkdD0sqGQ=="
}

Charging waypoint metadata

The Directions API returns charging stops as waypoints along the route. Each charging waypoint has additional metadata describing the charging stop. The following attributes are present in the metadata object:

Property	Type	Description
`type`	string	The type of waypoint. Set to `charging-station` for charging stops.
`name`	string	The name of the EV charging station.
`charge_time`	number	Time in seconds the EV needs to charge for at the station.
`charge_to`	number	Watt-hours the EV needs to charge to at the station.
`charge_at_arrival`	number	Battery charge, in Watt-hours, available on arrival at the station.
`plug_type`	string	The connector type to use for charging at the station.
`power_kw`	number	The maximum power available for the connector type to use for charging at the station.
`station_id`	string	Unique ID of the charging station.

Waypoint object

The response body of a Directions API query contains a waypoint object, the input coordinates snapped to the roads network. A waypoint object contains the following properties:

Property	Type	Description
`name`	string	The name of the road or path to which the input coordinate has been snapped.
`location`	array	The snapped coordinate as `[longitude, latitude]`.
`distance`	number	Optional. The straight-line distance from the coordinate specified in the query to the location it was snapped to.
`metadata`	object	Optional. An object describing charging stops inserted by EV Routing for routes requiring charging along the way. Its set to `null` for user provided waypoints including start & end locations.

Example waypoint object

{
    "name": "Kirkjubøarvegur",
    "location": [ -6.80897, 62.000075 ],
    "distance": 25
}

Route object

The response body of a Directions API query also contains an array of route objects. A route object describes a route through multiple waypoints. A route object contains the following properties:

Property	Type	Description
`duration`	number	The estimated travel time through the waypoints, in seconds.
`distance`	number	The distance traveled through the waypoints, in meters.
`weight_name`	string	The weight used. The default is `routability`, which is duration-based, with additional penalties for less desirable maneuvers.
`weight`	number	The weight in units described by `weight_name`.
`duration_typical`	number	When using the `driving-traffic` profile, this will be returned as a float indicating the duration of the route under typical conditions (not taking into account live traffic).
`weight_typical`	number	When using the `driving-traffic` profile, this will be returned as a float indicating the weight of the selected route under typical conditions (not taking into account live traffic).
`geometry`	string	Depending on the `geometries` query parameter, this is either a GeoJSON LineString or a Polyline string. Depending on the `overview` query parameter, this is the complete route geometry (`full`), a simplified geometry to the zoom level at which the route can be displayed in full (`simplified`), or is not included (`false`).
`legs`	array	An array of route leg objects.
`voiceLocale`	string	The locale used for voice instructions. Defaults to `en` (English). Can be any accepted instruction language. `voiceLocale` is only present in the response when `voice_instructions=true`.

Example route object

{
    "duration": 88.4,
    "distance": 830.4,
    "weight": 88.4,
    "weight_name": "routability",
    "geometry": "oklyJ`{ph@yBuY_F{^_FxJoBrBs@d@mAT",
    "legs": [ ],
    "voiceLocale": "en"
}

Route leg object

Route leg objects are nested within the route object. A route leg is the journey from an origin point to a destination point, so a route will usually contain one fewer route legs than it has number of input coordinates. Using the waypoints= parameter will override this. For example:

A route request with two input coordinates defines one leg with no waypoints.
A route request with three input coordinates defines two legs with one waypoint.
A route request with four input coordinates will have two legs if it includes the waypoints= parameter specifying three waypoints.

Each route leg object contains the following properties:

Property Type Description

distance number The distance traveled between waypoints, in meters.

duration number The estimated travel time between waypoints, in seconds.

weight number The weight in units described by weight_name.

duration_typical number When using the driving-traffic profile, this will be returned as indication of duration of the leg under typical conditions (not taking into account live traffic).

weight_typical number When using the driving-traffic profile, this will be returned as indication of the weight of the leg under typical conditions (not taking into account live traffic).

steps array Depending on the optional steps parameter, either an array of route step objects (steps=true) or an empty array (steps=false, default).

summary string A summary of the route.

admins array An array of objects describing the administrative boundaries the route leg travels through. Use admin_index on the intersection object to look up the administrative boundaries for each intersection in this array.

incidents array An array of incident objects describing temporary events that occur along the roadway. This is only provided if incidents exist and you are using the mapbox/driving-traffic profile.

closures

array

Included in the route leg object when making a mapbox/driving-traffic request with annotations=closure,... and there are live-traffic closures along the route. This is an array of closure objects which contain the following properties:

Property	Description
`geometry_index_start`	The position in the coordinate list where the closure began, relative to the start of the leg it's on.
`geometry_index_end`	The position in the coordinate list where the closure ended, relative to the start of the leg it's on.

admins.iso_3166_1 string Contains the two-letter ISO 3166-1 alpha-2 code that applies to a country boundary. Example: "US".

admins.iso_3166_1_alpha3 string Contains the three-letter ISO 3166-1 alpha-3 code that applies to a country boundary. Example: "USA".

annotation object An annotations object that contains additional details about each line segment along the route geometry. Each entry in an annotations field corresponds to a coordinate along the route geometry.

annotation.congestion string The level of congestion, described as severe, heavy, moderate, low or unknown, between each entry in the array of coordinate pairs in the route leg. For any profile other than mapbox/driving-traffic a list of unknowns will be returned.

annotation.congestion_numeric number or null The level of congestion in numeric form, from 0-100. A value of 0 indicates no congestion, a value of 100 indicates maximum congestion. Entries may be null if congestion on that segment is not known.

annotation.distance number The distance between each pair of coordinates, in meters.

annotation.duration number The duration between each pair of coordinates, in seconds.

annotation.maxspeed

object

The local posted speed limit between each pair of coordinates. A maxspeed object contains the following properties:

Property	Description
`speed`	The maximum speed limit between the coordinates of a segment. The value can be either the legal speed limit or an advisory speed limit where posted, or `none` if the speed limit is unlimited (for instance, a German Autobahn).
`unit`	The unit of measurement that `speed` is expressed in, either `km/h` or `mph`. Returned in combination with `speed`.
`unknown`	Returns `true` if the speed limit is not known.

Note that unknown will not be present if speed and unit are present in an individual maxspeed object, and that speed and unit will not be present if unknown is present.

annotation.speed number The average speed used in the calculation between the two points in each pair of coordinates, in meters per second.

via_waypoints array When the semicolon-separated list waypoints parameter is used in the request, an array per leg is returned that describes where a particular waypoint from the root-level array matches to the route. This provides a way for tracking when a waypoint is passed along the route. Also see the optional waypoints parameter description.

via_waypoints.waypoint_index number The associated waypoint index, excluding the origin (index 0) and destination.

via_waypoints.distance_from_start double The calculated distance, in meters, from the leg origin.

via_waypoints.geometry_index number The associated leg shape index of the via waypoint location.

Example route leg object

{
    "via_waypoints": [
        {
          "waypoint_index": 1,
          "distance_from_start": 127.951,
          "geometry_index": 6
        },
        {
          "waypoint_index": 2,
          "distance_from_start": 236.822,
          "geometry_index": 10
        }
    ],
    "annotation": {
        "distance": [
            4.294596842089401,
            5.051172053200946,
            5.533254065167979,
            6.576513793849532,
            7.4449640160938015,
            8.468757534990829,
            15.202780313562714,
            7.056346577326572
        ],
        "duration": [
            1,
            1.2,
            2,
            1.6,
            1.8,
            2,
            3.6,
            1.7
        ],
        "speed": [
            4.3,
            4.2,
            2.8,
            4.1,
            4.1,
            4.2,
            4.2,
            4.2
        ],
        "congestion": [
            "low",
            "moderate",
            "moderate",
            "moderate",
            "heavy",
            "heavy",
            "heavy",
            "heavy"
        ],
        "maxspeed": [
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          },
          {
            "speed": 56,
            "unit": "km/h"
          }
        ]
    },
    "duration": 99.824,
    "weight": 131.349,
    "distance": 580.039,
    "steps": [],
    "summary": ""
}

Route step object

In a route leg object, a nested route step object includes one step maneuver object as well as information about travel to the following route step:

Property Type Description

maneuver object One step maneuver object.

distance number The distance traveled, in meters, from the maneuver to the next route step.

duration number The estimated time traveled, in seconds, from the maneuver to the next route step.

weight number The weight in units described by weight_name.

duration_typical number When using the driving-traffic profile, this will be returned as indication of duration of the step under typical conditions (not taking into account live traffic).

weight_typical number When using the driving-traffic profile, this will be returned as indication of the weight of the step under typical conditions (not taking into account live traffic).

geometry string Depending on the geometries parameter, this is a GeoJSON LineString or a Polyline string representing the full route geometry from this route step to the next route step.

name string The name of the road or path that forms part of the route step.

ref string Any road designations associated with the road or path leading from this step’s maneuver to the next step’s maneuver. If multiple road designations are associated with the road, they are separated by semicolons. Typically consists of an alphabetic network code (identifying the road type or numbering system), a space or hyphen, and a route number. Optionally included, if data is available.
Note: A network code is not necessarily globally unique, and should not be treated as though it is. A route number may not uniquely identify a road within a given network.

destinations string The destinations of the road or path along which the travel proceeds. Optionally included, if data is available.

exits string The exit numbers or names of the road or path. Optionally included, if data is available.

driving_side string The legal driving side at the location for this step. Either left or right.

mode

string

The mode of transportation.

Profile	Possible values
`mapbox/driving`	`driving`, `ferry`, `unaccessible`
`mapbox/walking`	`walking`, `ferry`, `unaccessible`
`mapbox/cycling`	`cycling`, `walking`, `ferry`, `train`, `unaccessible`

pronunciation string An IPA phonetic transcription indicating how to pronounce the name in the name property. Omitted if pronunciation data is not available for the step.

intersections array An array of objects representing all the intersections along the step:

intersections.location array A [longitude, latitude] pair describing the location of the turn.

intersections.bearings array A list of bearing values that are available at the intersection. The bearings describe all available roads at the intersection.

intersections.classes

array

An array of strings signifying the classes of the road exiting the intersection.

Possible values	Description
`toll`	Road continues on a toll road
`ferry`	Road continues on a ferry
`restricted`	Road continues on with access restrictions
`motorway`	Road continues on a motorway
`tunnel`	Road continues in a tunnel

intersections.entry array A list of entry flags, corresponding with the entries in bearings. If the flag is true, indicates that the respective road could be entered on a valid route. If false, the turn onto the respective road would violate a restriction.

intersections.geometry_index integer The zero-based index into the geometry for the step. This value can be used to apply the duration annotation that corresponds with the intersection. Only available on the driving, driving-traffic, and walking profile.

intersections.in integer The index in the bearings and entry arrays. Used to calculate the bearing before the turn. Namely, the clockwise angle from true north to the direction of travel before the maneuver/passing the intersection. To get the bearing in the direction of driving, the bearing has to be rotated by a value of 180. The value is not supplied for departure maneuvers.

intersections.out integer The index in the bearings and entry arrays. Used to extract the bearing after the turn. Namely, the clockwise angle from true north to the direction of travel after the maneuver/passing the intersection. The value is not supplied for arrival maneuvers.

intersections.lanes array An array of lane objects that represent the available turn lanes at the intersection. If no lane information is available for an intersection, the lanes property will not be present.

intersections.duration number The time required, in seconds, to traverse the intersection. Only available on the driving profile.

intersections.tunnel_name string The name of the tunnel when the road exiting the intersection continues in a tunnel. This property is only included when the tunnel has a specified name. Only available on the driving profile.

intersections.mapbox_streets_v8 object Contains detailed information about the road exiting the intersection along the route. Properties in this object correspond to properties in the Mapbox Streets v8 road specification. Only available on the driving profile.

intersections.mapbox_streets_v8.class string The road class of the road exiting the intersection as defined by the Mapbox Streets v8 road class specification. Valid values include, but are not limited to, those supported by Mapbox Streets v8. For example: motorway, motorway_link, primary, and street.

intersections.is_urban boolean Indicates whether the road exiting the intersection is considered to be in an urban area. This value is determined by the density of the surrounding road network. Only available on the driving profile.

intersections.admin_index integer The zero-based index into the administrative boundaries list on the route leg for this intersection. Use this field to look up the ISO 3166-1 country code for this point on the route. Only available on the driving profile.

intersections.rest_stop object Contains information about passing rest stops along the route. Only available on the driving profile.

intersections.rest_stop.type string The type of rest stop, always included in the rest_stop object. Valid values include, but are not limited to, rest_area (includes parking only) and service_area (includes amenities such as gas or restaurants).

intersections.rest_stop.name string The name of the rest stop. Optionally included if data is available.

intersections.toll_collection object Contains information about a toll collection point along the route. This is a payment booth or overhead electronic gantry where a toll charge may be collected. Only available on the driving profile.

intersections.toll_collection.type string The type of toll collection point, always included in the toll_collection object. Valid values include, but are not limited to, toll_booth and toll_gantry.

intersections.toll_collection.name string The name of toll collection point. Optionally included if data is available.

intersections.railway_crossing boolean Indicates whether there is a railway crossing at the intersection.

intersections.traffic_signal boolean Indicates whether there is a traffic signal at the intersection.

intersections.stop_sign boolean Indicates whether there is a stop sign at the intersection.

intersections.yield_sign boolean Indicates whether there is a yield sign at the intersection.

speedLimitSign string The basic design of speed limit signs along the route step, either mutcd (Manual on Uniform Traffic Control Devices) or vienna (Vienna Convention on Road Signs and Signals). Only present in the response when the annotations query parameter contains maxspeed.

speedLimitUnit string The unit of measurement for speed that is used locally along the step, either km/h or mph. This unit is an appropriate default unit to display in the absence of a user preference; it may differ from the unit property of the annotation objects. Only present in the response when the annotations query parameter contains maxspeed.

Example route step object

{
    "intersections": [
      {
        "out": 1,
        "location": [ 13.424671, 52.508812 ],
        "bearings": [ 120, 210, 300 ],
        "entry": [ false, true, true ],
        "in": 0,
        "stop_sign": true,
        "lanes": [
          {
            "valid": true,
            "active": true,
            "valid_indication": "straight",
            "indications": [ "left", "straight" ]
          },
          {
            "valid": true,
            "active": false,
            "valid_indication": "straight",
            "indications": [ "straight", "right" ]
          },
          {
            "valid": false,
            "active": false,
            "indications": [ "right" ]
          }
        ]
      }
    ],
    "geometry": "asn_Ie_}pAdKxG",
    "maneuver": {
      "bearing_after": 202,
      "type": "turn",
      "modifier": "left",
      "bearing_before": 299,
      "location": [ 13.424671, 52.508812 ],
      "instruction": "Turn left onto Adalbertstraße"
    },
    "duration": 59.1,
    "distance": 236.9,
    "driving_side": "right",
    "weight": 59.1,
    "name": "Adalbertstraße",
    "mode": "driving"
}

Step maneuver object

A route step object contains a nested step maneuver object, which contains the following properties:

Property Type Description

bearing_before integer A number between 0 and 360 indicating the clockwise angle from true north to the direction of travel immediately before the maneuver.

bearing_after integer A number between 0 and 360 indicating the clockwise angle from true north to the direction of travel immediately after the maneuver.

instruction string A human-readable instruction of how to execute the returned maneuver.

location array The coordinates of the maneuver as [longitude, latitude].

modifier

string

Optional. The direction change of the maneuver. The meaning of each modifier depends on the type property.

Possible values	Description
`uturn`	Indicates a reversal of direction. `type` can be `turn` or `continue` when staying on the same road.
`sharp right`	A sharp right turn.
`right`	A normal turn to the right.
`slight right`	A slight turn to the right.
`straight`	No relevant change in direction.
`slight left`	A slight turn to the left.
`left`	A normal turn to the left.
`sharp left`	A sharp turn to the left.

If the source or target location is close enough to the depart or arrive location, no modifier will be given.

type string Indicates the type of maneuver. See the full list of maneuver types in the maneuver types table. If no modifier is provided, the type of maneuvers is limited to depart and arrive.

Maneuver types

`type`	Description
`turn`	A basic turn in the direction of the modifier.
`new name`	The road name changes (after a mandatory turn).
`depart`	Indicates departure from a leg. The `modifier` value indicates the position of the departure point in relation to the current direction of travel.
`arrive`	Indicates arrival to a destination of a leg. The `modifier` value indicates the position of the arrival point in relation to the current direction of travel.
`merge`	Merge onto a street.
`on ramp`	Take a ramp to enter a highway.
`off ramp`	Take a ramp to exit a highway.
`fork`	Take the left or right side of a fork.
`end of road`	Road ends in a T intersection.
`continue`	Continue on a street after a turn.
`roundabout`	Traverse roundabout. Has an additional property `exit` in the route step that contains the exit number. The `modifier` specifies the direction of entering the roundabout.
`rotary`	A traffic circle. While very similar to a larger version of a roundabout, it does not necessarily follow roundabout rules for right of way. It can offer `rotary_name` parameters, `rotary_pronunciation` parameters, or both, located in the route step object in addition to the `exit` property.
`roundabout turn`	A small roundabout that is treated as an intersection.
`notification`	Indicates a change of driving conditions, for example changing the `mode` from `driving` to `ferry`.
`exit roundabout`	Indicates the exit maneuver from a roundabout. Will not appear in results unless you supply the `roundabout_exits=true` query parameter in the request.
`exit rotary`	Indicates the exit maneuver from a rotary. Will not appear in results unless you supply the `roundabout_exits=true` query parameter in the request.

Note

New properties, potentially depending on type, may be introduced in the future without an API version change.

Example step maneuver object

{
    "bearing_before": 299,
    "bearing_after": 202,
    "type": "turn",
    "modifier": "left",
    "location": [ 13.424671, 52.508812 ],
    "instruction": "Turn left onto Adalbertstraße"
}

Lane object

A route step object contains a nested lane object. The lane object describes the available turn lanes at an intersection. Lanes are provided in their order on the street, from left to right.

Property Type Description

valid boolean Indicates whether a lane can be taken to complete the maneuver (true) or not (false). For instance, if the lane array has four objects and the first two are valid, the driver can take either of the left lanes and stay on the route.

active boolean Indicates whether this lane is a preferred lane (true) or not (false). A preferred lane is a lane that is recommended if there are multiple lanes available. For example, if guidance indicates that the driver must turn left at an intersection and there are multiple left turn lanes, the left turn lane that will better prepare the driver for the next maneuver will be marked as active. Only available on the mapbox/driving profile.

valid_indication string When either valid or active is set to true, this property shows which of the lane indications is applicable to the current route, when there is more than one. For example, if a lane allows you to go left or straight but your current route is guiding you to the left, then this value will be set to left. See indications for possible values. When both active and valid are false, this property will not be included in the response. Only available on the mapbox/driving profile.

indications

array

The indications (based on signs, road markings, or both) for each turn lane. A road can have multiple indications. For example, a turn lane can have a sign with an arrow pointing left and another arrow pointing straight.

Possible values	Description
`none`	No dedicated indication is shown
`straight`	An indication signaling to continue straight
`sharp left`	An indication signaling a sharp left turn
`left`	An indication signaling a left turn
`slight left`	An indication signaling a slight left turn
`slight right`	An indication signaling a slight right turn
`right`	An indication signaling a right turn
`sharp right`	An indication signaling a sharp right turn
`uturn`	An indication signaling the possibility to reverse direction by making a u-turn

Example lane object

{
    "valid": true,
    "active": true,
    "valid_indication": "left",
    "indications": [
        "left"
    ]
}

Voice instruction object

A route step object contains a nested voice instruction object if the optional voice_instructions=true query parameter is present. The voice instruction object contains the text that should be announced, along with how far from the maneuver it should be emitted. The system will announce the instructions during the route step in which the voice instruction object is nested, but the instructions refer to the maneuver in the following step.

Property	Type	Description
`distanceAlongGeometry`	number	A float indicating how far from the upcoming maneuver the voice instruction should begin, in meters.
`announcement`	string	The text of the verbal instruction.
`ssmlAnnouncement`	string	Contains SSML markup for proper text and pronunciation. This property is designed for use with Amazon Polly. The SSML tags may not work with other text-to-speech engines.

Example voice instruction object

{
    "distanceAlongGeometry": 375.7,
    "announcement": "In a quarter mile, take the ramp on the right towards I 495: Baltimore",
    "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">In a quarter mile, take the ramp on the right towards <say-as interpret-as=\"address\">I-495</say-as>: Baltimore</prosody></amazon:effect></speak>"
}

A route step object contains a nested banner instruction object if the optional banner_instructions=true query parameter is present. The banner instruction object contains the contents of a banner that should be displayed as added visual guidance for a route. The banner instructions are children of the route steps during which they should be displayed, but they refer to the maneuver in the following step.

Property	Type	Description
`distanceAlongGeometry`	number	A float indicating how far from the upcoming maneuver the banner instruction should begin being displayed, in meters. Only one banner should be displayed at a time.
`primary`	object	The most important content to display to the user. This text is larger and at the top.
`secondary`	object or `null`	Optional. Additional content useful for visual guidance. This text is slightly smaller and below `primary`. Can be `null`.
`sub`	object	Optional. Additional information that is included if the driver needs to be notified about something. Can include information about the next maneuver (the one after the upcoming one) if the step is short. If lane information is available, that takes precedence over information about the next maneuver.

Each of the different banner types (primary, secondary, and sub) contains the following properties:

Property Type Description

text string All the text that should be displayed.

type string Optional. The type of maneuver. May be used in combination with the modifier (and, if it is a roundabout, the degrees) for an icon to display. Possible values: turn, merge, depart, arrive, fork, off ramp, and roundabout.

modifier

string

Optional. The modifier for the maneuver. Can be used in combination with the type (and, if it is a roundabout, the degrees) for an icon to display.

Possible values	Description
`uturn`	Indicates a reversal of direction
`sharp right`	A sharp right turn
`right`	A normal turn to the right
`slight right`	A slight turn to the right
`straight`	No relevant change in direction
`slight left`	A slight turn to the left
`left`	A normal turn to the left
`sharp left`	A sharp turn to the left

degrees integer Optional. The degrees at which you will be exiting a roundabout, assuming 180 indicates going straight through the roundabout.

driving_side string Optional. The side of the street on which people drive in that location. Can be left or right.

components array An array of objects that, together, make up what should be displayed in the banner. Includes additional information intended to be used to aid in visual layout. A component can contain the following properties:

components.type

string

Contains more context about the component that may help in visual markup and display choices. If the type of the component is unknown, it should be treated as text.

Possible values	Description
`text`	Default. Indicates the text is part of the instructions and no other type.
`icon`	This is text that can be replaced by an `imageBaseURL` icon.
`delimiter`	This is text that can be dropped, and should be dropped if you are rendering icons.
`exit-number`	Indicates the exit number for the maneuver.
`exit`	Provides the the word for exit in the local language.
`lane`	Indicates which lanes can be used to complete the maneuver.

The introduction of new types is not considered a breaking change.

components.text string The sub-string of the text of the parent objects that may have additional context associated with it

components.abbr string Optional. The abbreviated form of text. If this is present, there will also be an abbr_priority value. For an example of using abbr and abbr_priority, see the abbreviation examples table.

components.abbr_priority integer Optional. Indicates the order in which the abbreviation abbr should be used in place of text. The highest priority is 0, while a higher integer value means it should have a lower priority. There are no gaps in integer values. Multiple components can have the same abbr_priority. When this happens, all components with the same abbr_priority should be abbreviated at the same time. Finding no larger values of abbr_priority means that the string is fully abbreviated.

components.imageBaseURL string Optional. Points to a shield image to use instead of the text. The shield image can be retrieved as an SVG by appending .svg to the URL string, or it can be retrieved as a PNG at 1-3× pixel density by appending @1x.png, @2x.png, or @3x.png to the URL string.

components.directions array Optional. Indicates which directions you can go from a lane (left, right, or straight). If the value is ['left', 'straight'], the driver can go straight or left from that lane. Present if components.type is lane.

components.active boolean Optional. Indicates whether that lane can be used to complete the upcoming maneuver. If multiple lanes are active, then they can all be used to complete the upcoming maneuver. Present if components.type is lane.

components.active_direction string Optional. When components.active is set to true, this property shows which of the lane's components.directions is applicable to the current route, when there is more than one. For example, if a lane allows you to go left or straight but your current route is guiding you to the left, then this value will be set to left. See component.directions for possible values. When components.active is false, this property will not be included in the response. Only available on the mapbox/driving profile.

Abbreviation examples

`text`	`abbr`	`abbr_priority`
North	N	1
Franklin Drive	Franklin Dr	0

Given the components in the table above, the possible abbreviations are, in order:

North Franklin Dr
N Franklin Dr

{
    "distanceAlongGeometry": 100,
    "primary": {
        "type": "turn",
        "modifier": "left",
        "text": "I 495 North / I 95",
        "components": [
          {
            "text": "I 495",
            "imageBaseURL": "https://s3.amazonaws.com/mapbox/shields/v3/i-495",
            "type": "icon"
          },
          {
            "text": "North",
            "type": "text",
            "abbr": "N",
            "abbr_priority": 0
          },
          {
            "text": "/",
            "type": "delimiter"
          },
          {
            "text": "I 95",
            "imageBaseURL": "https://s3.amazonaws.com/mapbox/shields/v3/i-95",
            "type": "icon"
          }
        ]
    },
    "secondary": {
        "type": "turn",
        "modifier": "left",
        "text": "Baltimore / Northern Virginia",
        "components": [
          {
            "text": "Baltimore",
            "type": "text"
          },
          {
            "text": "/",
            "type": "text"
          },
          {
            "text": "Northern Virginia",
            "type": "text"
          }
      ]
    },
    "sub": {
        "text": "",
        "components": [
          {
            "text": "",
            "type": "lane",
            "directions": ["left"],
            "active": true
          },
          {
            "text": "",
            "type": "lane",
            "directions": ["left", "straight"],
            "active": true
          },
          {
            "text": "",
            "type": "lane",
            "directions": ["right"],
            "active": false
          }
        ]
    }
}

Incident object

The incident object is included in the route leg object when making a mapbox/driving-traffic request in cases where there are incidents along the route.

Property	Type	Description
`id`	string	The unique ID of the incident.
`type`	string	The type of incident this is. It can be one of several possible incidents including: `accident`, `congestion`, `construction`, `disabled_vehicle`, `lane_restriction`, `mass_transit`, `miscellaneous`, `other_news`, `planned_event`, `road_closure`, `road_hazard`, `weather`.
`description`	string	A short description of the incident in a human-readable format.
`long_description`	string	A long description of the incident in a human-readable format.
`creation_time`	string	The time this incident first appeared as an incident on the map in ISO-8601 format (for example, `2020-12-18T15:56:53Z`).
`start_time`	string	The time this incident was started or is expected to start in ISO-8601 format (for example, `2020-12-18T15:56:53Z`).
`end_time`	string	The time this incident ended or is expected to end in ISO-8601 format (for example, `2020-12-18T15:56:53Z`).
`impact`	string	The impact of the incident on local traffic. Can be one of: `unknown`, `critical`, `major`, `minor`, `low`.
`alertc_codes`	array	Integers that give more detailed information about the type of incident. For the full list of alert codes, see the OpenStreetMap wiki's event code list.
`lanes_blocked`	array	Lanes that are blocked by the incident. Some examples of values include: `left`, `left center`, `left turn lane`, `center`, `right`, `right center`, `right turn lane`, `hov`.
`num_lanes_blocked`	integer	The number of items in the `lanes_blocked` array.
`congestion`	object	Contains information about the amount of congestion on the road around the incident.
`congestion.value`	integer	A number between `0` and `101` representing the level of congestion caused by the incident. The higher the number, the more congestion there is. A value of `0` means there is no congestion on the road. A value of `100` means that the road is closed. A value of `101` means that no congestion was calculated.
`closed`	boolean	If this is `true` then the road has been completely closed.
`geometry_index_start`	integer	The position in the coordinate list where the incident began, relative to the start of the leg it's on.
`geometry_index_end`	integer	The position in the coordinate list where the incident ended, relative to the start of the leg it's on.
`sub_type`	string	This could contain additional information about the type of incident.
`sub_type_description`	string	This could contain detail about the value of the `sub_type` field.
`iso_3166_1_alpha2`	string	The two-letter ISO 3166-1 alpha-2 code for the country the incident is located in. Example: `"US"`.
`iso_3166_1_alpha3`	string	The three-letter ISO 3166-1 alpha-3 code for the country the incident is located in. Example: `"USA"`.
`affected_road_names`	array	List of roads names affected by the incident. Alternate road names are separated by a `/`. The list is ordered from the first affected road to the last one that the incident lies on.

Instructions languages

The table below shows supported language codes used with the language parameter for turn-by-turn instructions. The language parameter will automatically be set to en (English) if an unsupported language code is used.

Code	Language	Text	Voice
`ar` or `ar-AE`	Arabic	✅	—
`cmn-CN`	Chinese (Mandarin)	—	✅
`cs-CZ`	Czech (Czech Republic)	✅	—
`cy-GB`	Welsh (United Kingdom)	—	✅
`da` or `da-DK`	Danish	✅	✅
`de` or `de-DE`	German	✅	✅
`el-GR`	Greek (Greece)	✅	—
`en-AU`	English (Australia)	—	✅
`en-GB-WLS`	English (Welsh)	—	✅
`en-GB`	English (UK)	✅	✅
`en-IN`	English (India)	—	✅
`en-SG`	English (Singapore)	✅	—
`en` or `en-US`	English (United States)	✅	✅
`es-MX`	Spanish (Mexico)	✅	—
`es-US`	Spanish (United States)	—	✅
`es` or `es-ES`	Spanish (Spain)	✅	✅
`et` or `et-EE`	Estonian	✅	—
`fi` or `fi-FI`	Finnish	✅	—
`fr-CA`	French (Canada)	✅	✅
`Fr` or `fr-FR`	French	✅	✅
`he` or `he-IL`	Hebrew	✅	—
`hr-HR`	Croatian(Croatia)	✅	—
`hu` or `hu-HU`	Hungarian	✅	—
`id` or `id-ID`	Indonesian	✅	—
`is-IS`	Icelandic (Iceland)	—	✅
`it` or `it-IT`	Italian	✅	✅
`ja` or `ja-JP`	Japanese	✅	✅
`ko` or `ko-KR`	Korean	✅	✅
`lv-LV`	Latvian(Latvia)	✅	—
`lt-LT`	Lithuanian(Lithuania)	✅	—
`nl-BE`	Dutch (Belgium)	✅	—
`nl` or `nl-NL`	Dutch	✅	✅
`no` or `nb-NO`	Norwegian (Bokmål)	✅	✅
`pl` or `pl-PL`	Polish	✅	✅
`pt-BR`	Portuguese (Brazil)	✅	✅
`pt-PT`	Portuguese (Portugal)	✅	✅
`ro` or `ro-RO`	Romanian	✅	✅
`ru` or `ru-RU`	Russian	✅	✅
`sk-SK`	Slovak (Slovakia)	✅	—
`sl` or `sl-SI`	Slovene	✅	—
`sr-RS`	Serbian(Serbia)	✅	—
`sv` or `sv-SE`	Swedish	✅	✅
`th-TH`	Thai (Thailand)	✅	—
`tr` or `tr-TR`	Turkish	✅	✅
`uk` or `uk-UA`	Ukrainian	✅	—
`vi` or `vi-VN`	Vietnamese	✅	—
`zh-CN`	Chinese (China)	✅	—

Directions API errors

On error, the server responds with different HTTP status codes:

For responses with HTTP status codes lower than 500, the JSON response body includes the code property, which may be used by client programs to manage control flow. The response body may also include a message property with a human-readable explanation of the error.
If a server error occurs, the HTTP status code will be 500 or higher and the response will not include a code property.

Response body `code`	HTTP status code	Description
`Ok`	`200`	Normal success case.
`NoRoute`	`200`	There was no route found for the given coordinates. Check for impossible routes (for example, routes over oceans without ferry connections).
`NoSegment`	`200`	No road segment could be matched for one or more coordinates within the supplied `radiuses`. Check for coordinates that are too far away from a road.
`Forbidden`	`403`	There may be an issue with your account. Check your Account page for more details. In some cases, using an access tokens with URL restrictions can also result in a `403` error. For more information, see our Token management guide.
`ProfileNotFound`	`404`	Use a valid profile as described in the list of routing profiles.
`InvalidInput`	`422`	The given request was not valid. The `message` key of the response will hold an explanation of the invalid input.

Directions API restrictions and limits

Requests using the driving, driving-traffic, walking, and cycling profiles can specify up to 25 total waypoints (input coordinates that are snapped to the roads network) along the route.
- Traffic coverage for the driving-traffic profile is available in supported geographies. Requests to this profile revert to driving profile results for areas without traffic coverage.
Maximum 300 requests per minute.
Requests that contain multiple coordinates are counted as 1 request.
Maximum total distance between all waypoints:
- 10,000 kilometers for the driving and driving-traffic profiles.
- 10,000 kilometers for the cycling profile.
- 1,000 kilometers for the walking profile.
Inter-continental route requests are not supported.
Route requests through water bodies are not supported.

If you require a higher rate limit, contact us.

Directions API pricing

Billed by requests
See rates and discounts per Directions API request in the pricing page's Navigation section

Usage of the Directions API is measured in API requests. A request that contains multiple waypoints is billed as a single API request. Details about the number of Directions API requests included in the free tier and the cost per request beyond what is included in the free tier are available on the pricing page.