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

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

Location

Message

Error Type

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

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

Routing type: <ul type="disk"><li> `driving` - car route. </li></ul>

Which points from the `points` array are starting points (array of indexes)

Date and time to use instead of the current date and time. Specified in <a href='https://tools.ietf.org/html/rfc3339#section-5.8' target='_blank'>RFC 3339</a> format (e.g., <i>2020-05-15T15:52:01Z</i>).

Which points from the `points` array are end points (array of indexes)

Route type: <ul type="disk"> <li> `jam` - shortest route in time using current traffic data </li><li> `statistics` - shortest route in time using statistical traffic data </li><li> `shortest` - shortest route in distance </li></ul>

Task status for building the adjacency matrix

Additional information about the task status

Task status: <ul type="disk"> <li> `TASK_CREATED` - task has been created. </li><li> `TASK_IN_QUEUE` - task is in a queue, waiting to be processed. </li><li> `TASK_IN_PROGRESS` - task is being processed. </li><li> `TASK_DONE` - task was completed. </li><li> `TASK_CANCELED` - task was cancelled. </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 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_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> `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> `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>

Maneuver description as a human-readable string

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>

Turn at a crossroad: <ul type="disk"><li> `straight` - straight ahead </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> `uturn_right` - U-turn (for right-hand traffic) </li><li> `uturn_left` - U-turn (for left-hand traffic) </li></ul>

Maneuver type: <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> `turn_over` - U-turn, </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>

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.

Point type: <ul type="disk"> <li> `stop` - start or end point of the route (with a straight 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>

Z level of the point (level of an interchange)

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

Additional request options: <ul type="disk"> <li> `pedestrian_instructions` - enable pedestrian navigation instructions (for pedestrian routes) </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> `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> `emergency` - emergency vehicle route </li><li> `pedestrian` - pedestrian route </li><li> `bicycle` - bicycle route </li></ul>

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>.

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 successfully excluded from the route

An array of original and aligned route points

If true, this point is an intermediate point

Information about car section of the route

Route section geometry in WKT format (LINESTRING)

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></ul>

Information about metro section of the route

Recommended car number for boarding (3 numbers max). Cars are numbered from left to right. This field is used for cities with a small metro system.

Recommended car number for boarding (5 numbers max). Cars are numbered from left to right. This field is used instead of `boarding_parts_suggest` for cities with a large metro system.

A hint describing the car number for boarding. This field is used for cities with a small metro system.

A hint describing the car number for boarding. This field is used instead of `boarding_parts_suggest` for cities with a large metro system.

Movement geometry. To be filled in if the movement type is passage, walkway or crossing.

Start coordinate Z-level. To be filled in if the movement type is walkway or crossing.

Finish coordinate Z-level. To be filled in if the movement type is walkway or crossing.

All routes on this section, grouped by type of transport.

To be filled in if the movement can be made by several types of transport or if the only type of transport is not metro or auto.

Type of movement: <ul type="disk"><li> `passage` - passage by public transport </li><li> `walkway` - walking section of a route </li><li> `crossing` - crossing between different platforms, metro entrances, parking lots </li><li> `driving` - driving section of a route </li></ul>

Sun City, a multifunctional complex

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

Name of the stop after which you need to get off

82,776851 54,982770

82,988150 55,017812

If true, the response will include transport schedule.

Maximum number of travel options in the response

Travel start date and time. Specified as <a href='https://en.wikipedia.org/wiki/Unix_time' target='_blank'>Unix time</a>. If not specified, the current time is used.

Types of public transport that can be used when building a route: <ul type="disk"> <li> `aeroexpress` - Aeroexpress </li><li> `bus` - bus </li><li> `cable_car` - cable car </li><li> `funicular_railway` - funicular railway </li><li> `light_metro` - light metro </li><li> `light_rail` - light rail </li><li> `mcc` - Moscow Central Circle </li><li> `mcd` - Moscow Central Diameters </li><li> `metro` - metro </li><li> `monorail` - monorail </li><li> `premetro` - premetro </li><li> `river_transport` - river transport </li><li> `shuttle_bus` - shuttle bus </li><li> `suburban_train` - suburban train </li><li> `tram` - tram </li><li> `trolleybus` - trolleybus </li></ul>

Number of transfers that require walking to another platform

If true, the route is completely pedestrian.

Total duration of the walking part of the route as a localized string

Number of transfers without changing the platform

Types of transport that were used to build the route

Arrival interval in minutes (for the `periodic` schedule type)

Date and time of the arrival in <a href='https://en.wikipedia.org/wiki/Unix_time' target='_blank'>Unix time</a> format

Type of schedule: <ul type="disk"><li> `precise` - exact times of arrival </li><li> `periodic` - only average interval of arrival </li></ul>

Date and time of the event in <a href='https://en.wikipedia.org/wiki/Unix_time' target='_blank'>Unix time</a> format

Type of schedule: <ul type="disk"><li> `night_break` - night break </li><li> `begin_trips` - early start </li></ul>

Brief information about the start point movement

If true, the route section can be traveled by different types of transport.

Additional information (duration of the walking part, for example)

Coordinates or name of the starting point of the movement

Routing type: <ul type="disk"><li> `driving` — car route </li><li> `truck` — сargo transport </li><li> `taxi` — car route (including public transport lanes) </li><li> `walking` — pedestrian route </li><li> `bicycle` — bicycle route </li></ul>

Identifier of a pass for a zone (array of numbers)

The result of building the adjacency matrix

Roads to avoid when building a route. Can be a string (single road type) or an array of strings (multiple road types). <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>

Detailed information about the route edge, including geometry

Expected speed along the edge - taking the statistics into account

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>

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

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>

If true, the section includes public transport lanes.

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>

Starting point coordinates that were used to build the reachable area (may slightly differ from `start_point`)

Movement type: <ul type="disk"> <li> `driving` - by car </li><li> `bicycle` - by bicycle </li><li> `walking` - on foot </li></ul>

If true, the direction of movement will be reversed: <ul type="disk"> <li> `false` - move from the specified point </li><li> `true` - move to the specified point </li></ul>

If true, the polygon that forms the area will be simplified (less vertices): <ul type="disk"> <li> `false` - detailed polygon </li><li> `true` - simplified polygon </li></ul>

Date and time to start the movement in <a href='https://tools.ietf.org/html/rfc3339#section-5.8' target='_blank'>RFC 3339</a> format (for example, <i>2020-05-15T15:52:01Z</i>)

Description of the error if there was any

Time taken to generate the response in seconds

Status of the response: <ul type="disk"> <li> `OK` - area was successfully built </li><li> `incorrect_input` - invalid input data </li><li> `build_error` - error while building the area </li><li> `attract_error` - a calculation error </li><li> `serialize_error` - a serialization error </li></ul>

Index of the starting point (from the `points` array)

Request status: <ul type="disk"> <li> `OK` - route was successfully built </li><li> `FAIL` - an unknown error occurred when calculating the route </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><li> `ROUTE_DOES_NOT_EXISTS` - the route between points on the road graph doesn't exist</li><li> `ROUTE_NOT_FOUND` - the route could not be build on the current data of the road graph</li><li> `POINT_EXCLUDED` - one of the points was excluded by the excluded objects</li></ul>

Index of the end point (from the `points` array)

The icon type for the maneuver: <ul type="disk"> <li> `start` - Start moving straight ahead  </li><li> `finish` - End of the movement  </li><li> `crossroad_straight` - Straight ahead </li>  <li> `crossroad_slightly_left` -  A smooth turn to the left  </li><li> `crossroad_left` - Left turn </li><li> `crossroad_sharply_left` - A sharp turn to the left </li><li> `crossroad_sharply_right` - A sharp turn to the right </li><li> `crossroad_right` - Turn right </li><li> `crossroad_slightly_right` - Smooth right turn </li> <li> `ringroad_forward` - Move forward at 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> `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` - A toll road </li></ul>

The type of the maneuver: <ul type="disk"> <li> `begin` - the start of the movement  </li><li> `end` - the end of the movement  </li><li> `crossroad` - passing through an intersection  </li><li> `ringroad` - circular movement, exit number such-and-such  </li><li> `pass_through` - a pass-through maneuver, e.g. 'Drive under the barrier'  </li><li> `turn_over` - a U-turn</li></ul>

Error description. For example, `Invalid value: 'lon' = 31415 at index 2`

Error type: <ul type="disk"> <li> `Invalid_Request` - JSON schema error </li><li> `Bad_Request` - data error</li></ul>

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

Length of the reconstructed route in meters

Duration of the reconstructed route in seconds

Geometry of the reconstructed route in WKT format

Was the route successfully reconstructed: <ul type="disk"> <li> `OK` - the route was successfully reconstructed </li><li> `FAIL` - failed to reconstruct the route</li></ul>

Direction of movement at departure point in degrees

Direction of movement at arrival point in degrees

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

Array of routes. Can consist of up to 50 routes.

Route geometry in WKT format in case of full output. Empty string in case of simplified output.

Request status: <ul type="disk"> <li> `incorrect_input` - invalid request </li></ul>

Enable pedestrian navigation instructions (for pedestrian routes)

If true, this entrance can be used as an exit.

Metro entrance coordinates in WKT format (POINT)

Logo of the metro line used for exit (if available)

If true, the exit is located on a different line of the metro.

List of transport routes for each type of transport

Type of movement: <ul type="disk"><li> `passage` - passage by transport </li><li> `walkway` - walking from the starting point to a public transport stop or from a transport stop to the destination point </li><li> `crossing` - crossing from one platform to another </li></ul>

Waiting duration in seconds. Equals zero for a walking movement (`type!=passage`) 

Novosibirsk Sun City multifunctional complex

Novosibirsk Opera and Ballet Theater

Public transport schedule for the first movement along the route (until the first transfer, if any)

Schedule of additional events for the first movement along the route (until the first transfer, if any)

Local arrival time as a number of seconds from the start of the day

Local event time as a number of seconds from the start of the day

The result of building routes between points

The travel time for the found route in seconds

Request status: <ul type="disk"> <li> `OK` - route was successfully calculated </li><li> `FAIL` - an unknown error occurred when calculating the route</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><li> `ROUTE_DOES_NOT_EXISTS` - the route between points on the road graph doesn't exist</li><li> `ROUTE_NOT_FOUND` - the route could not be build on the current data of the road graph</li><li> `POINT_EXCLUDED` - one of the points was excluded by the excluded objects</li></ul>

Route mode: <ul type="disk"> <li>`fastest` - shortest route in time using traffic data  </li><li> `shortest` - shortest route in distance </li></ul>

The length of pedestrian passage from a point (organization) to the road

The location of the start or end point of the route at the first and the last edges in the edges array, respectively.

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>

Error message. It is present only if the route between a pair of points could not be built.

The time spent on route generation in seconds

An array of found routes. For each successive pair of points, there is exactly one route. Thus, in the case of P-P, there will be one route here, but in general there will be N-1 routes for N points.

Total duration of all routes in the chain in meters

Total travel time along all routes in the chain in seconds

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

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

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

Array of routes. Can consist of up to 50 routes. (expected more than 2 points)

Route jam type: <ul type="disk"> <li> `jam` - use current traffic dat </li><li> `statistics` - use statistical traffic data </li></ul>

Roads to avoid when building a route. Can be a string (single road type) or an array of strings (multiple road types). <ul type="disk"> <li> `dirt_road` - avoid dirt roads when building a route </li><li> `toll_road` - avoid toll roads when building a route</li></ul>

Route type: <ul type="disk"> <li> `truck_jam` - shortest route in time using current traffic data </li><li> `truck_statistic` - shortest route in time using statistical traffic data </li><li> `truck_shortest` - shortest route in distance</li></ul>

If are_truck_pass_zones_ignored is true, route goes through pass zone although pass hadn't been specified

Whether the truck route passes through regions with no limitations data available. <ul type="disk"> <li> `full` - limitations data is available for the entirety of the route </li><li> `partial` - the route partially passes through regions with no limitations data available </li><li> `no` - no limitations data available for the entire route</li></ul>

The list of road types that are included in the resulting route. Only road types that can be filtered are checked. Description of the values: <ul type="disk"> <li> `dirt_road` - dirt roads </li><li> `toll_road` - toll roads.</li></ul>

Types of roads that were requested to be avoided

Identifiers of a pass zones (array of numbers) are contained in a route

Agent Id

Capacity

Finish Waypoint Id

Start Waypoint Id

Work Time Window

Agent

ValidationError

Detail

HTTPValidationError

Point

URL of the file containing the excluded points list

Url Excluded

URL of the file containing the task solution

Url Vrp Solution

Urls

Task status: <ul type="disk"> <li> `Run` — the task is processing, </li><li> `Done` — the route was successfully built, </li><li> `Partial` — the route was built, but some points were excluded, </li><li> `Fail` — an error occurred while building the route, </li><li> `Not Found` — the task was not found </li></ul>

PublicTaskStatus

List of points to traverse (up to 200 points)

Agents

Use blocked roads when building a route or not

A set of excluded areas that should be avoided when building a route. Not more than 25 areas.

RoutingOptions

The start time of the movement  in RFC-3339 format. For example: 2016-11-15T15:52:01+04:00; if the string is empty, the current time value is used

Start Time

Waypoints

ClientRequest

Reachability matrix calculation duration (in seconds)

Queue time for reachability matrix calculation (in seconds)

Dm Queue

Task Id

Traveling salesman task calculation duration (in seconds)

Queue time for traveling salesman task calculation (in seconds)

ClientResponse

Vrp Queue

Routing type: <ul type="disk"><li> `driving` — car route. </li></ul>

RoutingMode

Route type: <ul type="disk"> <li> `jam` — shortest route in time using current traffic data </li><li> `statistics` — shortest route in time using statistical traffic data </li><li> `shortest` — shortest route in distance </li></ul>

Routing API