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

Public Transport API

Спецификация OpenAPI

2GIS Navigation API (6.0.0)

Маршрут на общественном транспорте

Построение маршрута проезда на общественном транспорте

Построение маршрута проезда на общественном транспорте

query Parameters
key
required
string

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

Request Body schema: */*
required

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

boolean or null

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

boolean or null

Если true, то будет включена пиксельная притяжка.

Locale (string) or null
integer or null

Дата и время начала движения. Указывается как Unix-время. Если параметр не указан, используется текущее время.

required
object (SourceTargetObj)

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

required
object (SourceTargetObj)

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

Array of objects (SourceTargetObj)

Промежуточные точки в маршруте (максимальное значение: 10)

transport
required
Array of strings (CTXTransportType)
Items Enum: "pedestrian" "metro" "light_metro" "suburban_train" "aeroexpress" "tram" "bus" "trolleybus" "shuttle_bus" "monorail" "funicular_railway" "river_transport" "cable_car" "light_rail" "premetro" "mcc" "mcd"
integer or null

Максимальное количество вариантов маршрута в ответе

integer or null

Максимальное количество прямых маршрутов в ответе

Responses

Response Schema: application/json
Array
integer or null

Идентификатор варианта проезда по маршруту

crossing_count
required
integer >= 0

Количество пересадок, для которых нужно перейти на другую платформу

string or null

Идентификатор маршрута

required
Array of objects (Movement)
pedestrian
required
boolean

Если true, маршрут полностью пешеходный

transfer_count
required
integer >= 0

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

total_distance
required
integer >= 0

Расстояние в пути в метрах

total_duration
required
integer >= 0

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

total_walkway_distance
required
string

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

Array of CTXTransportType (strings) or null
Array of Waypoint (objects) or null
Array of ScheduleItem (objects) or null
Array of ScheduleEventsItem (objects) or null

Response samples

Content type
application/json
[
  • [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
]