Формат запроса

https://api.routing.yandex.net/v2/route
  ? apikey=<string>
  & waypoints=<lat1,lon1|lat2,lon2|...>
  & [mode=<string>]
  & [departure_time=<integer>]
  & [avoid_tolls=<boolean>]
  & [avoid_unpaved=<boolean>]
  & [avoid_poor_condition=<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>]
  & [vehicle_permits=<string>]
  & [levels=<string>]
  & [results=<integer>]
  & [optimize=<boolean>]
  & [signature=<string>]

Все параметры

apikey

Обязательный параметр

Ключ, полученный в Кабинете Разработчика.

Примечание

Ключ будет активирован в течение 15 минут после получения.

Настройка ограничений для API-ключа

waypoints

Обязательный параметр

Точки маршрутов, указанные в десятичных градусах (стандарт WGS84).
Каждая точка описывается парой координат в следующем формате: <широта,долгота>
Пары координат (точки) разделяются знаком «|» (вертикальная черта).

  • Если в поле mode указано driving или truck, максимальное число элементов — 50.
  • Для всех остальных способов перемещения максимальное число элементов — 25.

mode

Способ перемещения по маршруту. Допустимые значения:

  • driving — маршрут для легкового автомобиля, используется по умолчанию;
  • truck — маршрут для грузового автомобиля;
  • walking — маршрут для пешехода;
  • transit — маршрут с использованием общественного транспорта;
  • bicycle — маршрут для велосипеда;
  • scooter — маршрут для электросамоката.

Внимание

При планировании маршрутов для грузовых автомобилей будут учитываться ограничения в соответствии с ПДД РФ. Учитываются знаки 3.4, 3.7, 3.11, 3.12, 3.13, 3.14, 3.15, 5.35, 5.36 и табличка 8.11.

При планировании маршрутов для электросамокатов также будут учитываться ограничения в соответствии с ПДД РФ. Учитывается знак 3.35.

departure_time

Время отправления в формате UNIX-времени. Используется для расчета ожидаемых пробок на дорогах. Если параметр не указан, используется прогноз пробок на момент обработки запроса.
Параметр не может принимать значения времени в прошлом.

Внимание

Параметр не учитывается при расчете маршрута:

  • для пешеходов, велосипедов и электросамокатов (mode=walking, mode=bicycle или mode=scooter),
  • без учета дорожного трафика (traffic=disabled).

avoid_tolls

Только для mode=driving или mode=truck

Запрет на использование платных дорог. При значении true маршрут будет построен в обход платных дорог. Значение по умолчанию — false.

avoid_unpaved

Только для mode=driving или mode=truck

Запрет на использование дорог без твёрдого покрытия. При значении true маршрут будет построен в обход дорог без твёрдого покрытия. Значение по умолчанию — false.

Доступ к этому параметру предоставляется на платных тарифах.

avoid_poor_condition

Только для mode=driving или mode=truck

Запрет на использование дорог в плохом состоянии. При значении true маршрут будет построен в обход дорог в плохом состоянии. Значение по умолчанию — false.

Доступ к этому параметру предоставляется на платных тарифах.

avoid_zones

Только для mode=driving или mode=truck

Задание произвольной геозоны на карте, дороги внутри которой надо исключить при построении маршрута. Можно задавать несколько геозон в 1 запросе. Каждая геозона минимум 3 точки.

traffic

Только для mode=driving или mode=truck

Изменение типа дорожного трафика. При значении disabled маршрут будет построен по кратчайшему расстоянию, без учета пробок.

weight

Только для mode=truck

Масса транспортного средства в тоннах.

axle_weigh

Только для mode=truck

Фактическая нагрузка на ось транспортного средства в тоннах.

max_weight

Только для mode=truck

Разрешенная максимальная масса транспортного средства в тоннах.

height

Только для mode=truck

Высота транспортного средства в метрах.

width

Только для mode=truck

Ширина транспортного средства в метрах.

length

Только для mode=truck

Длина транспортного средства в метрах.

payload

Только для mode=truck

Максимальная грузоподъёмность транспортного средства в тоннах.

eco_class

Только для mode=truck

Экологический класс транспортного средства.

has_trailer

Только для mode=truck

Наличие прицепа. Значение по умолчанию — false.

vehicle_permits

Только для mode=truck

Пропуска для въезда в определенные зоны. Список значений, разделенных запятой. Допустимые значения:

  • msk_mkad - разрешает въезд на МКАД и внутрь МКАДА в Москве
  • msk_ttk - разрешает въезд на ТТК и внутрь ТТК в Москве
  • msk_sk - разрешает въезд на Садовое кольцо и внутрь Садового кольца в Москве
  • spb_kad - разрешает въезд на КАД и внутрь КАДа в Санкт-Петербурге

Доступ к этому параметру предоставляется на платных тарифах.

levels

Только для mode=walking или mode=transit

Этажи для точек маршрута, указанные через запятую. Количество этажей должно соответствовать количеству точек в параметре waypoints.

Доступ к этому параметру предоставляется на платных тарифах.

results

Количество маршрутов в ответе. Допустимые значения от 1 до 3.

В ответе может быть меньше маршрутов, если дополнительные маршруты невозможно построить.

Доступ к этому параметру предоставляется на платных тарифах.

optimize

Только для mode=driving, mode=truck, mode=walking или mode=transit

Оптимизация порядка точек маршрута для построения оптимального маршрута. Первая точка в списке waypoints остается неизменной.

Доступ к этому параметру предоставляется на платных тарифах.

signature

Подпись запроса. Служит для защиты ключа от кражи. Более подробно о подключении механизма подписи запросов можно узнать в документации.
Предыдущая
Быстрый старт
Следующая
Формат ответа