Request format

https://api.routing.yandex.net/v2/route
  ? apikey=<string>
  & waypoints=<lat1,lon1|lat2,lon2|...>
  & [mode=<string>]
  & [departure_time=<integer>]
  & [avoid_tolls=<boolean>]
  & [avoid_zones=<lat1,lon1|lat2,lon2|...>&avoid_zones=<lat1,lon1|lat2,lon2|...>]
  & [traffic=<string>]
  & [weight=<float>]
  & [axle_weight=<float>]
  & [max_weight=<float>]
  & [height=<float>]
  & [width=<float>]
  & [length=<float>]
  & [payload=<float>]
  & [eco_class=<integer>]
  & [has_trailer=<boolean>]

All params

apikey

Required parameter

The key issued in the Developer's Dashboard.

Note

Key activation takes up to 15 minutes.

Configuring restrictions for API keys

waypoints

Required parameter

Route points specified in decimal degrees (WGS84 standard).
Each point is defined as a coordinate pair in the format: <latitude,longitude>
Coordinate pairs (points) are separated with a vertical bar «|».

  • If driving or truck is specified in the mode field, the maximum number of elements is 50.
  • If walking or transit is specified in the mode field, the maximum number of elements is 25.

mode

Type of travel on the route. Acceptable values:

  • driving: Passenger car route. Used by default.
  • truck: Truck route.
  • walking: Walking route.
  • transit: Public transit route.

Alert

When planning routes for trucks, the traffic rules of the Russian Federation apply. The service uses signs 3.4, 3.7, 3.11, 3.12, 3.13, 3.14, 3.15, 5.35, and 5.36 and table 8.11.

departure_time

The departure time in UNIX time. Used for calculating the expected traffic congestion. If this parameter is not specified, the traffic forecast is made for time when the request was processed.
This value can't be in the past.

Alert

This parameter is not used when calculating routes:

  • for walking (mode=walking),
  • without traffic jams (traffic=disabled).

avoid_tolls

No toll roads. When true, the route avoids toll roads. Default value: false.

avoid_zones

Set up a custom polygon on the map to avoid it during routing. You can set up multiple polygons in the request. Each polygon should has at least 3 points

traffic

Change the type of road traffic. When disabled, the route is built according to the shortest distance, without traffic jams (only for mode=driving or mode=truck).

weight

Vehicle weight in tons (only for mode=truck).

axle_weight

Actual vehicle axle load in tons (only for mode=truck).

max_weight

Maximum allowed vehicle weight in tons (only for mode=truck).

height

Vehicle height in meters (only for mode=truck).

width

Vehicle width in meters (only for mode=truck).

length

Vehicle length in meters (only for mode=truck).

payload

Maximum vehicle load capacity in tons (only for mode=truck).

eco_class

Vehicle emission standard (only for mode=truck).

has_trailer

Trailer (only for mode=truck). Default value: false.
Previous
Quick start
Next
Response