Формат запроса генерации матрицы

POST https://api.routing.yandex.net/v2/distancematrix_async/{mode}/matrices/generate
  ? apikey=<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>]
  & [signature=<string>]
Content-Type: application/json

{
  "origins": [
    [lat1, lon1],
    [lat2, lon2],
    ...
  ],
  "destinations": [
    [lat1, lon1],
    [lat2, lon2],
    ...
  ]
}

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

mode

Обязательный параметр
Передается в пути запроса

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

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

Важно

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

apikey

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

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

Примечание

В настоящее время асинхронная матрица доступна только по дополнительному запросу.

Для того что бы оставить запрос свяжитесь с нами по почте paid-api-maps@yandex-team.ru.

origins

Обязательный параметр
Передается в теле запроса

Начальные точки маршрутов, указанные в десятичных градусах.
Каждая точка описывается парой координат в следующем формате: [latitude, longitude]

destinations

Обязательный параметр
Передается в теле запроса

Конечные точки маршрутов, указанные в десятичных градусах.
Каждая точка описывается парой координат в следующем формате: [latitude, longitude]

Из каждой начальной точки строятся маршруты во все конечные точки. Максимальный размер матрицы составляет 25 миллионов элементов.

departure_time

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

Важно

Параметр не учитывается при расчете маршрута без учета дорожного трафика (traffic=disabled).

avoid_tolls

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

avoid_unpaved

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

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

avoid_poor_condition

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

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

avoid_zones

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

traffic

Изменение типа дорожного трафика. При значении disabled маршрут будет построен по кратчайшему расстоянию, без учета пробок (только для mode=driving или mode=truck).

weight

Масса транспортного средства в тоннах (только для mode=truck).

axle_weight

Фактическая нагрузка на ось транспортного средства в тоннах (только для 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 - разрешает въезд на КАД и внутрь КАДа в Санкт-Петербурге

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

signature

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