Altitude information (if `need_altitudes` was specified in the request).

If true, the route may include driving on closed roads.

Number of alternative routes to be built in addition to the main route

An array of areas to avoid when building a route. Not more than 25 areas.

If true, altitude information will be included in the response.

If true, an indoor route will be included in the result (for pedestrian routes).

Date and time to use instead of the current date and time. Specified as <a href='https://en.wikipedia.org/wiki/Unix_time' target='_blank'>Unix time</a>.

Radius in meters around the specified coordinates to be avoided.

How strictly to avoid the area: <ul type="disk"> <li>soft - weak exclusion, try to avoid the area, </li><li>hard - strong exclusion, always avoid the area, </li></ul>

Shape of the area: <ul type="disk"> <li>point -  a circle with a radius equal to `extent` (`points` is the center of the circle), </li><li>polyline - a line with a width equal to `extent` (`points` are the vertices of the line), </li><li>polygon - a polygon (`points` are the vertices of the polygon), </li></ul>

Display style name of the section: <ul type="disk"> <li>fast - green line, </li><li>normal - yellow line, </li><li>slow - red line, </li><li>slow-jams - dark red line, </li><li>ignore - don't display the speed, </li><li>no-traffic - no speed information for the route, </li></ul>

Elevation angle (if `need_altitudes` was specified in the request).

If true, the section includes public transport lanes.

Vertical level of the section: <ul type="disk"> <li>archway - archway, </li><li>bridge - bridge, </li><li>crosswalk - crosswalk, </li><li>doubler - frontage road, </li><li>elevator - elevator, </li><li>escalator - escalator, </li><li>ford - ford, </li><li>indoor - indoor, </li><li>invisible - non-displayed section, </li><li>living_zone - living area, </li><li>normal - normal, </li><li>overgroundway - overhead passage, </li><li>park_footpath - unpaved footpath, </li><li>park_path - paved footpath, </li><li>pedestrian_bridge - footbridge, </li><li>stairway - stairway, </li><li>subway - metro station underpass, </li><li>tunnel - tunnel, </li><li>undergroundway - underpass, </li></ul>

Vertical level of the section: <ul type="disk"> <li>zlevel-normal - ground level, </li><li>zlevel-positive - above ground level, </li><li>zlevel-negative - below ground level, </li></ul>

Roads to exclude when building a route: <ul type="disk"> <li>toll_road - avoid toll roads when building a car route, </li><li>ferry - avoid ferries when building a car or pedestrian route, </li></ul>

Floor ID before the maneuver (for `indoor_*` maneuver types).

Floor name before the maneuver (for `indoor_*` maneuver types).

Floor ID after the maneuver (for `indoor_*` maneuver types).

Floor name after the maneuver (for `indoor_*` maneuver types).

Maneuver description as a human-readable string.

Maneuver icon name: <ul type="disk"> <li>start - start moving forward, </li><li>finish - stop at the arrival point, </li><li>crossroad_straight - straight ahead, </li><li>crossroad_keep_left - keep left, </li><li>crossroad_slightly_left - smooth turn to the left, </li><li>crossroad_left - turn to the left, </li><li>crossroad_sharply_left - sharp turn to the left, </li><li>crossroad_sharply_right - sharp turn to the right, </li><li>crossroad_right - turn to the right, </li><li>crossroad_slightly_right - smooth turn to the right, </li><li>crossroad_keep_right - keep right, </li><li>ringroad_forward - move straight on the ringroad, </li><li>ringroad_left_45 - on the ringroad, turn 45 degrees to the left, </li><li>ringroad_left_90 - on the ringroad, turn 90 degrees to the left, </li><li>ringroad_left_135 - on the ringroad, turn 135 degrees to the left, </li><li>ringroad_left_180 - on the ringroad, turn 180 degrees to the left, </li><li>ringroad_right_45 - on the ringroad, turn 45 degrees to the right, </li><li>ringroad_right_90 - on the ringroad, turn 90 degrees to the right, </li><li>ringroad_right_135 - on the ringroad, turn 135 degrees to the right, </li><li>ringroad_right_180 - on the ringroad, turn 180 degrees to the right, </li><li>ringroad_exit - exit from ringroad, </li><li>turn_over_right_hand - U-turn (for right-hand traffic), </li><li>turn_over_left_hand - U-turn (for left-hand traffic), </li><li>toll_icon - toll road ahead, </li><li>indoor_enter - building entrance, </li><li>indoor_exit - building exit, </li><li>indoor_floor_change_stairway - floor change by stairway, </li><li>indoor_floor_change_elevator - floor change by elevator, </li><li>indoor_floor_change_escalator - floor change by escalator, </li></ul>

Turn at a crossroad: <ul type="disk"> <li>straight - straight ahead, </li><li>keep_left - keep left, </li><li>slightly_left - smooth turn to the left, </li><li>left - turn to the left, </li><li>sharply_left - sharp turn to the left, </li><li>sharply_right - sharp turn to the right, </li><li>right - turn to the right, </li><li>slightly_right - smooth turn to the right, </li><li>keep_right - keep right, </li><li>uturn_right - U-turn (for right-hand traffic), </li><li>uturn_left - U-turn (for left-hand traffic), </li><li>turnover - U-turn, </li><li>right_with_left_turn - turn to the left followed by turn to the right, </li></ul>

Maneuver icon name: <ul type="disk"> <li>begin - start of the movement, </li><li>end - end of the movement, </li><li>crossroad - passing through an intersection, </li><li>ringroad - circular movement, </li><li>pass_through - pass-through maneuver (e.g., "Drive under the barrier"), </li><li>turnover - U-turn, </li><li>ringroad_exit - exit from ringroad, </li><li>pedestrian_begin - start of the pedestrian movement, </li><li>pedestrian_crossroad - pedestrian passing through an intersection, </li><li>pedestrian_end - end of the pedestrian movement, </li><li>pedestrian_road_crossing - pass through a pedestrian crossing, </li><li>indoor_enter - building entrance, </li><li>indoor_exit - building exit, </li><li>indoor_floor_change - floor change, </li></ul>

Output format: <ul type="disk"> <li>simple - simplified output (only length and estimated travel time), </li><li>full - full output (length, estimated travel time, and full route geometry), </li></ul>

Barrier type: <ul type="disk"> <li>barrier - a barrier, </li><li>gate - a gate, </li><li>tourniquet - a turnstile, </li><li>wicket - a wicket gate, </li></ul>

Payment type: <ul type="disk"> <li>unpaid - unpaid / free, </li><li>paid - payment required, </li><li>pass - pass required, </li></ul>

Toll road entrance or exit: <ul type="disk"> <li>toll_type_start - toll road entrance, </li><li>toll_type_end - toll road exit, </li></ul>

Type of the pass-through: <ul type="disk"> <li>main - central (main), </li><li>additional - additional, </li><li>service - service, </li></ul>

Roads to avoid when building a route: <ul type="disk"> <li>dirt_road - avoid dirt roads when building a car or pedestrian route, </li><li>toll_road - avoid toll roads when building a car route, </li><li>ferry - avoid ferries when building a car or pedestrian route, </li><li>highway - avoid highways when building a pedestrian route, </li><li>ban_car_road - avoid car roads when building a bicycle route, </li><li>ban_stairway - avoid stairways when building a bicycle route, </li><li>ban_over - avoid overground crossings and underground crossings when building a bicycle route, </li></ul>

Additional request options: <ul type="disk"> <li>pedestrian_instructions - enable pedestrian navigation instructions (for pedestrian routes), </li></ul>

Distance from the point in meters on which the direction of movement must be maintained. Starting point only.

ID of a floor of a building (for indoor routes).

ID of a building or organization. If exists, coordinates of that building or organization will be used instead of the coordinates specified in `x` and `y`.

If true, the point is the starting point of the route. If not specified, the starting point is the first point in the array.

Z level of the point (level of an interchange).

Point type: <ul type="disk"> <li>stop - start or end point of the route (with a straight path to a road), </li><li>pedo - start or end point of the route (with a pedestrian path to a road), </li><li>walking - start or end point of the route (with a pedestrian path to a road), </li><li>pref - intermediate point of the route, </li></ul>

Route type: <ul type="disk"> <li>jam - shortest route in time using current traffic data, </li><li>statistic - shortest route in time using statistical traffic data, </li><li>shortest - shortest route in distance, </li><li>pedestrian - pedestrian route, </li><li>taxi_jam - shortest route in time using current traffic data (including public transport lanes), </li><li>taxi_statistic - shortest route in time using statistical traffic data (including public transport lanes), </li><li>taxi_shortest - shortest route in distance (including public transport lanes), </li><li>bicycle - bicycle route, </li><li>scooter - scooter route, </li><li>emergency - emergency vehicle route, </li></ul>

Response type: <ul type="disk"> <li>result - Success result, </li><li>error - Error, </li></ul>

If true, the route includes closed roads.

Road types that are included in the route (of those that can be excluded).

Accuracy of the route as a number from 0 to 1 (if `distance_direction` was set).

Road types that were requested to be avoided.

Road types that were requested to be excluded.

Road types that were successfully excluded from the route.

An array of original and aligned route points.

Distance from the start of the route in meters (along the route).

Point type: <ul type="disk"> <li>TollRoadBegin - starting point of a toll road section, </li><li>TollRoadEnd - ending point of a toll road section, </li></ul>

Request status: <ul type="disk"> <li>OK - route was successfully calculated, </li><li>FAIL - an unknown error occurred when calculating the route, </li><li>POINT_EXCLUDED - one of the points was excluded by the excluded objects, </li><li>ROUTE_NOT_FOUND - the route could not be build on the current data of the road graph, </li><li>ROUTE_DOES_NOT_EXISTS - the route between points on the road graph doesn't exist, </li><li>ATTRACT_FAIL - an error occurred while attracting the points: one of the points is more than 10 km away from the road graph, </li></ul>

Сorrespondence between original and aligned route point.

If true, this point is an intermediate point.

2GIS Navigation API

The main API for building routes. A single route can consist of several points (up to 10).

Directions API