Перейти к основному содержимому

Примеры

Типы маршрута​

Кратчайший по времени​

По умолчанию строится кратчайший по времени автомобильный маршрут с учётом текущих пробок. Чтобы указать тип маршрута явно, добавьте в запрос поле type:

{
    "points": [...],
    "type": "jam" // автомобильный маршрут по текущим пробкам
}

Вместо текущих пробок можно использовать статистическую информацию по пробкам. Для этого укажите тип маршрута statistics и нужную дату и время в формате RFC 3339 в поле start_time:

{
    "points": [...],
    "type": "statistics", // автомобильный маршрут на основе статистических данных по пробкам...
    "start_time": "2020-05-15T15:52:01Z"    // ...на 15 мая 2020 года, 15:52:01 UTC
}

Кратчайший по расстоянию​

Чтобы построить самый короткий маршрут, даже если он не является оптимальным по времени, укажите тип shortest:

{
    "points": [...],
    "type": "shortest"
}

Способы передвижения​

На автомобиле​

По умолчанию строится автомобильный маршрут. Чтобы указать этот тип транспорта явно, добавьте в запрос параметр transport со значением driving:

{
    "points": [...]
    "transport": "driving" // автомобильный маршрут
}

На общественном транспорте​

Чтобы построить маршрут на общественном транспорте, отправьте запрос со следующими параметрами:

  • "transport": "public_transport" — способ передвижения: на общественном транспорте.
  • "public_transport_params" — параметры общественного транспорта:
    • "transport" — массив типов общественного транспорта. Например, bus — автобус, trolleybus — троллейбус. Полный список видов общественного транспорта см. в описании параметра public_transport_params в Справочнике API.
    • "enable_schedule" — учёт расписания общественного транспорта при построении маршрута.
{
    "points": [...],
    "transport": "public_transport", // маршрут для общественного транспорта
      "start_time": "2025-10-23T14:00:00Z",
      "public_transport_params": {
        "transport": [
          "bus",
          "trolleybus"
        ],
        "enable_schedule": true
      }
}

На грузовом транспорте​

Чтобы построить маршрут для грузового транспорта, укажите параметр transport со значением truck:

{
    "points": [...],
    "transport": "truck" // грузовой транспорт
}

На мотоцикле​

Чтобы построить маршрут для мотоциклов, укажите параметр transport со значением motorcycle:

{
    "points": [...],
    "transport": "motorcycle" // маршрут для мотоциклов
}

На велосипеде​

Чтобы построить велосипедный маршрут, укажите параметр transport со значением bicycle:

{
    "points": [...],
    "transport": "bicycle" // велосипедный маршрут
}

На самокате​

Чтобы построить самокатный маршрут, укажите параметр transport со значением scooter:

{
    "points": [...],
    "transport": "scooter" // самокатный маршрут
}

Пешком​

Чтобы построить пешеходный маршрут, укажите параметр transport со значением walking:

{
    "points": [...],
    "transport": "walking" // пешеходный маршрут
}

Специальные возможности​

Ограничение скорости движения​

По умолчанию маршруты строятся с учётом ограничений скорости движения, установленных правилами дорожного движения. Можно установить значение скорости, которое транспортное средство не должно превышать на любом участке маршрута.

Например, в ПДД для грузовиков установлены следующие ограничения скорости: 90 км/ч на автомагистралях и 60 км/ч в населённых пунктах. Если установить дополнительное ограничение скорости движения 75 км/ч, то время маршрута будет рассчитываться для скорости не более 75 км/ч на автомагистралях и не более 60 км/ч в населённых пунктах.

Чтобы установить ограничение, укажите в поле vehicle_speed_limit ограничение скорости движения в км/ч:

{
    "points": [...],
    "transport": "truck",
    "vehicle_speed_limit": 75
}

Учёт полос общественного транспорта​

Также можно строить маршруты с учётом полос общественного транспорта (удобно для такси и автобусов). Для этого добавьте в запрос поле transport со значением taxi:

{
    "points": [...],
    "transport": "taxi", // автомобильный маршрут, включающий полосы общественного транспорта
    "type": "shortest" // кратчайший по расстоянию
}

Исключение областей и типов дорог​

При построении маршрута можно исключить определенные типы дорог, такие как грунтовые или платные, и указать области, которые будут избегаться. Для этого используются параметры filters и exclude. Подробнее про работу с этими параметрами можно посмотреть в соответствующих разделах Routing API.

Высота маршрута​

Чтобы получить в ответе информацию о высоте пешеходного или велосипедного маршрута, добавьте в запрос поле need_altitudes со значением true:

{
    "points": [...],
    "transport": "walking", //или "transport": "bicycle"
    "need_altitudes": true
}

Пример ответа с информацией о высоте маршрута:

{
    "routes": [
        {
            ...
            "altitudes_info": {
                "elevation_gain": 0,
                "elevation_loss": 0,
                "max_altitude": 0,
                "min_altitude": 0,
                "max_road_angle": 0
                }
        },
        ...
    ]
}

Где:

  • elevation_gain — суммарное увеличение высоты в см;
  • elevation_loss — суммарное снижение высоты в см;
  • max_altitude — максимальная высота над уровнем моря в см;
  • min_altitude — минимальная высота над уровнем в см;
  • max_road_angle — максимальный угол наклона.