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

POST /get_dist_matrix

Спецификация OpenAPI
API docs by Redocly

2GIS Navigation API (6.0.0)

Алгоритмы

Получение информации о расстоянии и времени в пути между точками.

Получение информации о расстоянии и времени в пути между точками

query Parameters
key
required
string

API-ключ разработчика

version
required
string
Default: "2.0"

Версия API

response_format
string
Default: "json"
Enum: "protobuf" "json"

Формат ответа:

Request Body schema: */*
required

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

required
Array of objects (RequestPoint) non-empty

Массив точек.

sources
required
Array of integers non-empty [ items >= 0 ]

Какие точки из массива points являются точками отправления (массив индексов).

targets
required
Array of integers non-empty [ items >= 0 ]

Какие точки из массива points являются точками прибытия (массив индексов).

string or null

Дата и время начала движения в формате RFC 3339 (например, 2020-05-15T15:52:01Z). Если параметр не указан, используется текущее время.

transport
string
Default: "driving"
Enum: "driving" "taxi" "truck" "walking" "bicycle" "scooter" "motorcycle"

Тип движения:

  • driving - автомобильный,
  • taxi - автомобильный с учётом полос общественного транспорта,
  • truck - грузовой транспорт,
  • walking - пешеходный,
  • bicycle - велосипедный,
  • scooter - самокатный,
  • motorcycle - мотоциклетный,

type
string
Default: "jam"
Enum: "jam" "statistics" "shortest"

Тип маршрута:

  • jam - кратчайший по времени с учётом текущих пробок,
  • statistics - кратчайший по времени с учётом статистических данных по пробкам,
  • shortest - кратчайший по расстоянию,

Array of RequestFilter (strings) or RequestFilter (string) or null
boolean or null

Если true, при построении маршрута могут использоваться перекрытые дороги.

Array of objects (ExcludeObject)

Набор исключаемых областей, которые следует избегать при построении маршрута. Не более 25.

TruckParams (object) or null
number or null

Ограничение средней скорости движения км/ч.

pass_zone_pass_ids
Array of integers
Default: []

Идентификаторы пропуска в пропускную зону (массив чисел).

boolean or null

Если true, в ответ будет добавлена информация о высоте маршрута.

Responses

Response Schema: application/json
Array of RoutesItem (objects) or null

Массив найденных маршрутов. Для каждой последовательной пары точек находится ровно один маршрут.Таким образом, в случае P-P здесь будет один маршрут, а в общем случае с N точек будет N-1 маршрут

Any of
Array
status
required
string (StatusType)
Enum: "FAIL" "OK" "POINT_EXCLUDED" "ROUTE_NOT_FOUND" "ROUTE_DOES_NOT_EXISTS" "ATTRACT_FAIL"

Статус обработки запроса:

  • FAIL - неизвестная ошибка построения маршрута,
  • OK - маршрут построен успешно,
  • POINT_EXCLUDED - точки попали в зону исключения,
  • ROUTE_NOT_FOUND - маршрут не удалось построить на текущих данных дорожного графа,
  • ROUTE_DOES_NOT_EXISTS - маршрут между точками на дорожном графе не существует,
  • ATTRACT_FAIL - не удалось притянуть точки к дорожному графу: одна из точек маршрута удалена от дорожного графа более,чем на 10 км,

source_id
required
integer >= 0

Индекс точки отправления (из массива points)

target_id
required
integer >= 0

Индекс точки прибытия (из массива points)

distance
required
integer >= 0

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

duration
required
integer >= 0

Время в пути в секундах

number or null <double>

Точность маршрута в виде числа от 0 до 1 (если был указан параметр distance_direction

boolean or null

Если true, часть маршрута проходит по перекрытым дорогам.

AltitudesInfo (object) or null

Response samples

Content type
application/json
{
  • "routes": [
    • {
      }
    ]
}