Поиск маршрутов

Осуществляет поиск маршрутов общественного транспорта, которые соответствуют заданным условиям поиска.

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

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

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

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

Пример: 1234567890.

region_id Да Число Идентификатор региона.
q Да Строка

Запрос, по которому производится выборка маршрутов (номер маршрута или его часть, название ветки метро и т.д.).

subtype Нет Строка

Перечень типов маршрутов, которые необходимо выводить в результатах. По умолчанию выводятся все типы. Подробнее см. Типы маршрутов

page Нет Число Номер запрашиваемой страницы. Значение по умолчанию: 1.
page_size Нет Число

Ограничение количества выводимых результатов. Может быть в диапазоне от 1 до 2000. По умолчанию равно 20.

locale Нет Строка Локаль на которой отдавать результат. Возможные значения:
  • cs_CZ
  • en_CY
  • es_CL
  • it_IT
  • ru_RU
  • ru_KZ
  • ru_UA
  • en_AE
  • ar_AE
  • ru_KG
  • uk_UA
По умолчанию используется ru_RU.
format Нет Строка Формат ответа. Может принимать значения:
  • xml
  • json
  • jsonp
По умолчанию используется json.
callback Нет Строка

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

Пример: myCallback

fields Нет Строка

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

  • items.region_id

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

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

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

result* Структура

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

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

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

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

Количество найденных объектов.

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

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

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

Уникальный идентификатор маршрута.

region_id Строка

Входит в ответ, если указать items.region_id в fields.

type* Строка

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

  • route

type_name Строка

Человекопонятное наименование типа.

subtype* Строка

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

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

  • bus — автобус
  • trolleybus — троллейбус
  • tram — трамвай
  • shuttle_bus — маршрутное такси
  • metro — метро
  • suburban_train — электропоезд
  • funicular_railway — фуникулёр
  • monorail — монорельс
  • river_transport — водный транспорт
  • cable_car — канатная дорога
  • light_rail — скоростной трамвай
  • premetro — метротрам
  • light_metro — лёгкое метро
  • aeroexpress — аэроэкспресс

name* Строка

Название маршрута.

Примеры:

  • 71 (1231)
  • 1
  • K

color Строка

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

Примеры:

  • #D10000

from_name Строка

Название начальной остановки маршрута.

Примеры:

  • Ключ-Камышенское плато

to_name Строка

Название конечной остановки маршрута.

Примеры:

  • Тюленина

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

Направления маршрута

context Структура

Контекст поиска

reviews Структура

Отзывы о геообъекте

Направления маршрута (items.directions)
Параметр Тип Описание
id Строка

Уникальный 64-ех битный идентификатор направления маршрута (subroute).

type* Строка

Направление маршрута

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

  • forward — прямое направление
  • backward — обратное направление
  • additional — дополнительное направление
  • circular — круговой маршрут с конечной остановкой
  • loop — замкнутый маршрут без конечной остановки

name Строка

Название направления маршрута.

Примеры:

  • Маршрут
  • Обратный маршрут
  • До ТК Толмачёвский

geometry Структура

Геометрия направления маршрута

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

Последовательность остановочных платформ маршрута

Геометрия направления маршрута (items.directions.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Последовательность остановочных платформ маршрута (items.directions.platforms)
Параметр Тип Описание
id* Строка

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

station_id* Строка

Идентификатор остановки.

name* Строка

Название остановки.

Примеры:

  • Кинотеатр Маяковского

place_name Строка

Краткое описание места расположения остановочной платформы.

Примеры:

  • Кинотеатр Маяковского

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

Другие маршруты, на которые можно пересесть на данной остановочной платформе

geometry Структура

Геометрия остановочной платформы

Другие маршруты, на которые можно пересесть на данной остановочной платформе (items.directions.platforms.transitions)
Параметр Тип Описание
route_id* Строка

Идентификатор связанного маршрута.

route_name* Строка

Название связанного маршрута.

route_type* Строка

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

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

  • bus — автобус
  • trolleybus — троллейбус
  • tram — трамвай
  • shuttle_bus — маршрутное такси
  • metro — метро
  • suburban_train — электропоезд
  • funicular_railway — фуникулёр
  • monorail — монорельс
  • river_transport — водный транспорт
  • cable_car — канатная дорога
  • light_rail — скоростной трамвай
  • premetro — метротрам
  • light_metro — лёгкое метро
  • aeroexpress — аэроэкспресс

color Строка

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

Примеры:

  • #D10000

station_id* Строка

Идентификатор остановки.

station_name* Строка

Название остановки.

Геометрия остановочной платформы (items.directions.platforms.geometry)
Параметр Тип Описание
centroid Строка

Визуальный центр геометрии объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

hover Строка

Геометрия области, используемой для определения попадания курсора в зону объекта.

Примеры:

  • POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))

selection Строка

Геометрия для выделения объекта.

Примеры:

  • POINT(83.306820839303 54.6230101954005)

style Строка | Null

Идентификатор стиля для отображения.

Контекст поиска (items.context)
Параметр Тип Описание
found_through Строка

Найден ли маршрут через синоним. В значении содердится название синонима маршрута.

Отзывы о геообъекте (items.reviews)
Параметр Тип Описание
general_rating Число

Общий рейтинг объекта.

Примеры:

  • 4.73

general_review_count Целое число

Общее количество отзывов.

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

Список провайдеров

Список провайдеров (items.reviews.items)
Параметр Тип Описание
tag* Строка

Название провайдера.

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

  • flamp
  • foursquare
  • 2gis_reviews

is_reviewable* Булев

Можно ли отображать отзывы к этому объекту, а также создавать новые отзывы.

Примеры

  • Найти маршруты, в названии которых встречается "10". Показать только первый найденный маршрут.

    Запрос:

    http://catalog.api.2gis.ru/2.0/transport/route/search?q=10&region_id=1&page_size=1&key=1234567890

    Ответ:

  • Найти маршруты, в названии которых встречается "10", с указанием region_id. Показать только первый найденный маршрут.

    Запрос:

    http://catalog.api.2gis.ru/2.0/transport/route/search?q=10&region_id=1&page_size=1&fields=items.region_id&key=1234567890

    Ответ: