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

Обзор

Routing API позволяет строить на карте маршруты на транспорте (в том числе общественном) или пешком.

За один запрос вы можете построить:

  • Для общественного транспорта: маршрут для одного набора точек на разных видах общественного транспорта. Для построения используйте endpoint /public_transport/2.0.

    Статистика для общественного транспорта

    Если для построения маршрутов на общественном транспорте вы ранее пользовались Public Transport API, предыдущая статистика расходования лимитов и распределения запросов для Public Transport API сохранится.

  • Для остальных способов передвижения:

    • маршрут для одного набора точек;
    • маршруты для нескольких пар начальных и конечных точек.

    Для построения используйте endpoint /routing/7.0.0/global.

Если возможно, API строит несколько вариантов проезда по маршруту. Вы можете выбрать подходящий вариант маршрута, учитывая общее время в пути, расстояние, длину пешеходной части, а также другие параметры.

Используйте интерактивный пример построения маршрута на автомобиле:

Чтобы отредактировать код примера, нажмите Исходный код и затем Codepen.

Песочница для Routing API

Вы также можете поработать с Routing API в песочнице внутри личного кабинета (авторизация не требуется).

Основные возможности​

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

  • автомобиль;

  • такси;

  • велосипед;

  • самокат;

  • мотоцикл;

  • грузовой транспорт (есть ограничения по территориям);

  • экстренные службы;

  • пешком (в том числе можно строить маршруты внутри зданий);

  • общественный транспорт:

    • метро;
    • автобус;
    • трамвай;
    • троллейбус;
    • маршрутное такси;
    • пригородный поезд;
    • аэроэкспресс;
    • лёгкое метро;
    • монорельс;
    • фуникулёр;
    • речной транспорт;
    • канатная дорога;
    • легкорельсовый транспорт;
    • подземный трамвай;
    • Московское центральное кольцо;
    • Московские центральные диаметры.

Параметры маршрута​

При построении маршрутов вы можете указывать параметры в зависимости от способа передвижения и endpoint-а, к которому отправляется запрос.

Все способы, кроме общественного транспорта​

В запросе к /routing/7.0.0/global вы можете указать:

  • Координаты начальной и конечной точки, в том числе несколько пар.

  • Промежуточные точки маршрута (не поддерживаются при построении маршрутов для нескольких пар начальных и конечных точек).

  • Способ передвижения.

  • Фильтры, исключающие типы дорог из маршрута.

  • Фильтры, исключающие области на карте.

  • Формат результата: полная выдача с геометрией маршрута или упрощённая выдача только со временем и длиной.

  • Желаемое количество вариантов маршрута в ответе.

  • Параметр для построения кратчайшего по времени или расстоянию маршрута.

  • Параметр для учёта пробок: в реальном времени (с регулярным обновлением данных) или прогнозируемых на основе статистических данных.

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

  • Параметр для игнорирования перекрытий дорог.

  • Направление движения для начальной или конечной точки.

  • Дополнительно для грузового транспорта: массу и габариты транспортного средства, тип перевозимого груза, идентификаторы пропусков для въезда на территорию.

В ответе вы можете получить:

  • Несколько вариантов маршрута, если их возможно построить.
  • Полную геометрию всех участков маршрута в текстовом формате WKT (Well-Known Text).
  • Длину маршрута и время в пути: общую и для каждого участка.
  • Инструкции по каждому участку маршрута: например, повернуть направо, продолжать движение прямо и т. д.
  • Для велосипедных и пешеходных маршрутов: изменение высоты над уровнем моря на протяжении маршрута.
  • Информацию о специальных точках на маршруте: например, о начале платного участка дороги.
  • Информацию о стоимости платных участков дороги, если они есть на маршруте.

Подробную информацию о параметрах см. в Справочнике API.

Общественный транспорт​

В запросе к /public_transport/2.0 вы можете указать:

  • Время начала движения (отправления).
  • Координаты начальной и конечной точки.
  • Промежуточные точки маршрута.
  • Способ передвижения.
  • Параметр для учёта расписания общественного транспорта.
  • Максимальное количество вариантов маршрута в ответе.
  • Минимальное количество прямых маршрутов без пересадок в ответе.

В ответе вы можете получить:

  • Несколько вариантов маршрута, если их возможно построить.
  • Полную геометрию всех участков маршрута в текстовом формате WKT (Well-Known Text).
  • Список маршрутов общественного транспорта и остановок.
  • Расписание общественного транспорта и время прибытия на каждую остановку.
  • Общую длину маршрута, длину пешеходной части и время в пути.
  • Длину каждого участка маршрута, время в пути и время ожидания транспорта.
  • Количество пересадок и список остановок для пересадки.

Подробную информацию о параметрах см. в Справочнике API.

Ограничения​

Точки маршрута​

В одном запросе вы можете указать:

  • Для одного набора точек с учётом начальной и конечной:

    • Для общественного транспорта: до 12 точек.
    • Для пешеходных маршрутов: до 5 точек.
    • Для остальных способов передвижения: до 10 точек.

  • Для нескольких пар точек: до 50 пар точек. При этом нельзя указать промежуточные точки. Доступно для всех способов передвижения, кроме общественного транспорта.

Грузовой транспорт​

Построение маршрутов для грузового транспорта доступно в следующих странах:

  • Азербайджан,
  • Армения,
  • Беларусь,
  • Грузия,
  • Казахстан,
  • Кыргызстан,
  • Россия,
  • Узбекистан.

Тарифы​

  • Стоимость сервиса рассчитывается исходя из количества запросов в месяц. Один запрос соответствует построению маршрута для одного набора точек, включая промежуточные.
  • Построение вариантов маршрута в одном запросе дополнительно не оплачивается.
  • При построении маршрутов для нескольких пар точек оплачиваются расчёты для каждой пары. Например, если в одном запросе вы указываете 5 пар точек (поле points), оплачиваются 5 расчётов.
  • Актуальные тарифы можно посмотреть в Менеджере Платформы.

Варианты размещения​

  • Облако: все методы Routing API доступны через публичные endpoint-ы 2ГИС.
  • On-Premise: все методы Routing API доступны при установке API-платформы 2ГИС в закрытом контуре. Подробнее см. в разделе API-платформа для сервера.

Что дальше?​