Поиск проезда на автомобиле

Осуществляет прокладку маршрута проезда на автомобиле с учётом прогнозируемой дорожной ситуации.

URL: http://catalog.api.2gis.ru/2.0/transport/calculate_directions

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка

Уникальный ключ пользователя API.

Пример: 1234567890.

waypoints Да Строка

Точки, через которые необходимо проложить маршрут

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

  • Минимальное количество - 2
  • Максимальное количество - 20

Могут быть двух типов:

  • Точки остановки (по умолчанию)
  • Точки предпочтения (транзитные)

Этот параметр можно задавать в одном из двух форматов:

  • В виде пар координат в формате lon, lat разделенных запятыми. Все точки, указанные в таком виде считаются точками остановки. Например: waypoints=82.838287 54.96579,82.838287 54.97979
  • В виде json-строки. Например:

time Нет Строка

Время начала движения в формате w:H:i в часовом поясе региона, где

  • w - порядковый номер дня недели (0 - воскресенье, 6 - суббота)
  • H - час в 24-часовом формате (от 0 до 23)
  • i - минута (от 0 до 59)
По умолчанию равно времени запроса

routing_type Нет Строка

Тип расчета проезда

Допустимые значения:

  • shortest - кратчайший маршрут
  • optimal_statistic - оптимальный маршрут с учетом статистики
  • optimal_jams - оптимальный маршрут с учетом пробок

Значение по умолчанию - optimal_statistic

Может принимать несколько значений через запятую

edge_filter Нет Строка

Тип расчитываемого маршрута

Допустимые значения:

  • car - автомобильный
  • pedestrian - пешеходный

Значение по умолчанию - car

alternative Нет Число

Количество альтернативных маршрутов

Значение по умолчанию - 0

format Нет Строка Формат ответа. Может принимать значения:
  • xml
  • json
  • jsonp
По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания отобразится ошибка в формате json.

Пример: myCallback

Параметры ответа

Параметр Тип Описание
meta* Структура

Общая информация об ответе

result* Структура

Основной результат

Общая информация об ответе (meta)
Параметр Тип Описание
code* Целое число

Код ответа API. Подробнее см. Коды ответов

Основной результат (result)
Параметр Тип Описание
total* Целое число

Количество найденных вариантов

items* Массив структур

Массив найденных объектов

waypoints* Массив структур

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

Массив найденных объектов (items)
Параметр Тип Описание
type* Строка

Тип маршрута

Допустимые значения:

  • shortest — Кратчайший
  • optimal_statistic — Оптимальный
  • optimal_jams — Оптимальный с учетом пробок

total_duration Целое число

Продолжительность маршрута в секундах

total_distance Целое число

Длина маршрута в метрах

legs Массив структур

Массив сегментов маршрута

similar_to_index Целое число | Null

Индекс похожего маршрута

error_code Строка | Null

Код ошибки

error_message Строка | Null

Текст ошибки

Массив сегментов маршрута (items.legs)
Параметр Тип Описание
steps* Массив структур

Массив участков сегмента

Массив участков сегмента (items.legs.steps)
Параметр Тип Описание
edges* Массив структур

Массив ребер участка

streets Массив структур

Массив улиц (в порядке их прохождения)

duration* Целое число

Продолжительность проезда участка в секундах

distance* Целое число

Длина участка в метрах

maneuver* Структура

Структура, описывающая маневр (инструкцию водителю)

Массив ребер участка (items.legs.steps.edges)
Параметр Тип Описание
id* Строка

Идентификатор ребра

geometry* Структура

Геометрия

speed* Целое число

Скорость проезда по ребру, в м/с

Геометрия (items.legs.steps.edges.geometry)
Параметр Тип Описание
selection* Строка

Геометрия в формате WKT

Массив улиц (в порядке их прохождения) (items.legs.steps.streets)
Параметр Тип Описание
id* Строка

Идентификатор улицы

name* Строка

Название улицы

Структура, описывающая маневр (инструкцию водителю) (items.legs.steps.maneuver)
Параметр Тип Описание
type* Строка

Тип маневра

Допустимые значения:

  • begin — Начало
  • end — Конец
  • transit — Прохождение транзитной точки
  • crossroad — Инструкции перекрестка: прямо, направо, налево и с разными аттрибутами
  • ringroad — Кольцевое движение, такой-то съезд
  • special_maneuver — Специальный маневр, например "Въезд на мост"
  • pass_through — Маневр проезда, например "Проезд под шлагбаум"
  • turn_over — Разворот

type_name* Строка

Название типа маневра, например "Начало движения"

comment Строка

Текстовый комментарий к маневру, например "Въезд на мост"

ringroad_exit_number Целое число

Номер съезда с кольца. Присутствует если maneuver.type раве ringroad

turn_direction Строка

Тип поворота. Присутствует если maneuver.type равен crossroad

Допустимые значения:

  • straight — Прямо
  • slightly_left — Плавно налево
  • left — Налево
  • sharply_left — Резко налево
  • uturn — Разворот
  • sharply_right — Резко направо
  • right — Направо
  • slightly_right — Плавно направо

turn_angle Целое число

Угол поворота в градусах. Присутствует если maneuver.type равен сrossroad или ringroad. Диапазон значений: от 0 до 180 по часовой стрелке, от 0 до -180 против часовой.

pass_through Структура

Атрибуты проезда

Атрибуты проезда (items.legs.steps.maneuver.pass_through)
Параметр Тип Описание
type Строка

Тип проезда

Допустимые значения:

  • main — Основной
  • additional — Дополнительный
  • service — Служебный

payment Строка

Тип проезда

Допустимые значения:

  • unpaid — Бесплатный
  • paid — Платный
  • pass — Только по пропускам

barrier Строка

Тип препятствия

Допустимые значения:

  • none — Нет ограждения
  • gate — Ворота
  • barrier — Шлагбаум
  • turnstile — Турникет
  • wicket — Калитка

comment Строка

Текстовый комментарий

Точки маршрута (waypoints)
Параметр Тип Описание
transit* Булев

Является ли точка транзитной

original_point* Структура

Координаты точки, переданные в запрос

projected_point* Структура

Координаты точки, спроецированные на дорожный граф

Координаты точки, переданные в запрос (waypoints.original_point)
Параметр Тип Описание
lon* Число

Долгота

lat* Число

Широта

Координаты точки, спроецированные на дорожный граф (waypoints.projected_point)
Параметр Тип Описание
lon* Число

Долгота

lat* Число

Широта

Примеры

  • Найти проезд от точки с координатами 82.838287,54.96579 до точки 82.838287 54.97979.

    Запрос:

    http://catalog.api.2gis.ru/2.0/transport/calculate_directions?waypoints=82.838287 54.96579,82.838287 54.97979&key=1234567890

    Ответ: