Initial docs

This commit is contained in:
2026-08-13 18:26:15 +03:00
parent 8b7b988141
commit c78bf00f7a
12 changed files with 5128 additions and 0 deletions

View File

@@ -0,0 +1,905 @@
Расписание рейсов по станции
# Расписание рейсов по станции
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format)
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#emails-detailed)
Запрос позволяет получить список [рейсов](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#schedule), отправляющихся от указанной [станции](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#station) и информацию по каждому рейсу.
## Синтаксис запроса
```
https://api.rasp.yandex-net.ru/v3.0/schedule/ ?
apikey=<ключ>
& station=<код станции>
& [lang=<язык>]
& [format=<формат>]
& [date=<дата>]
& [transport_types=<тип транспорта>]
& [event=<прибытие или отправление>]
& [system=<система кодирования для параметра station>]
& [show_systems=<коды в ответе>]
& [direction=<направление>]
& [result_timezone=<часовой пояс>]
```
Пример запроса:
```
https://api.rasp.yandex-net.ru/v3.0/schedule/?apikey={ключ}&station=s9600213&transport_types=suburban&direction=на%20Москву
```
Входные параметры:
**Обязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
| `station` | Код станции. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system). |
**Необязательные параметры**
| | |
| --- | --- |
| **Параметр** | **Описание** |
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
| `date` | Дата, на которую необходимо получить список рейсов. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.<br>Если в запросе указана конкретная дата, в выдаче будут показаны все будущие рейсы, в том числе с пересадками.<br>Если запрос передан без даты, в выдаче будут показаны только прямые рейсы на все даты. В этом случае рейсы с пересадками не попадут в выдачу. |
| `transport_types` | Тип транспортного средства. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет.<br>По умолчанию возвращается список рейсов по всем типам транспортных средств. |
| `direction` | Код направления, по которому необходимо получить список рейсов электричек по станции (например, «arrival», «all» или «на Москву»).<br>Параметр `direction` игнорируется, если значение параметра `transport_types` отлично от `suburban`.<br>Доступные для станции коды направлений можно получить, запросив расписание на любую дату без параметра `direction`, но с параметром `transport_types=suburban`. Список направлений возвращается в элементе ответа `directions`. |
| `event` | Событие, для которого нужно отфильтровать нитки в расписании.<br>Поддерживаемые значения:<br>- `departure` — включить в ответ только отправляющиеся со станции нитки (по умолчанию);<br>- `arrival` — включить в ответ только прибывающие на станцию нитки. |
| `system` | [Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код станции (параметр `station`) в запросе. Возможные значения:<br>- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;<br>- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);<br>- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));<br>- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).<br>Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний. |
| `show_systems` | Система кодирования, в которой необходимо получить коды станций (в элементе ответа `codes`, вложенном в элемент `station`).<br>Возможные значения:<br>- `yandex` — система кодирования Яндекс Расписаний;<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0);<br>- `all` — коды всех поддерживаемых систем кодирования.<br>По умолчанию элемент `station` не содержит элемента `codes`. |
| `result_timezone` | Часовой пояс, для которого следует указывать даты и времена в ответе. Если параметр не передан, каждая дата и время в ответе будут указаны в часовом поясе соответствующей станции.<br>Часовые пояса следует указывать с помощью идентификаторов [базы данных tz](https://ru.wikipedia.org/wiki/Tz_database). В английской Википедии приведен список идентификаторов из последней версии этой базы данных (в столбце «TZ» таблицы). |
## Структура ответа
Ответ представляет собой список рейсов с подробным описанием каждого рейса.
Количество рейсов, отображаемых на одной странице — не более 100\. Информация об общем количестве полученных рейсов указана в ответе в элементе `total` элемента `pagination`.
Возможные форматы ответа: JSON, XML.
Структура ответа в различных форматах показана в примерах.
Пример ответа в формате JSON
Пример ответа в формате XML
```
{
"date": "2017-10-28",
"pagination":
{
"total": 210,
"limit": 100,
"offset": 0
},
"station":
{ /* hide:station */
"code": "s9600213",
"title": "Шереметьево",
"station_type": "аэропорт",
"popular_title": "",
"short_title": "",
"transport_type": "train",
"type": "station"
},
"schedule":
[\
{\
"except_days": "6, 7, 8, 9, 13, 14 февраля",\
"arrival": "2017-02-27T00:04:00+03:00",\
"thread":\
{ /* hide:thread */\
"uid":"7303A_9600213_g13_af",\
"title":"аэропорт Шереметьево - Москва (Белорусский вокзал)",\
"number":"7303",\
"short_title":"а/п Шереметьево - Москва (Белорусский вокзал)",\
"carrier":\
{ /* hide:carrier */\
"code": 153,\
"codes": {\
"icao": null,\
"sirena": null,\
"iata": null\
},\
"title": "Центральная пригородная пассажирская компания"\
},\
"transport_type":"suburban",\
"vehicle":null,\
"transport_subtype":\
{ /* hide:transport_subtype */\
"color": "#FF7F44",\
"code": "suburban",\
"title": "Пригородный поезд"\
},\
"express_type":"aeroexpress"\
},\
"is_fuzzy":false,\
"days":"ежедневно",\
"stops":"без остановок",\
"departure": "2017-02-27T00:05:00+03:00",\
"terminal": null,\
"platform": ""\
},\
...\
],
"interval_schedule":
[\
{\
"except_days": null,\
"thread":\
{\
"uid": "502-*28mxt*29_0_f9744758t9744460_r2531_1",\
"title": "Москва (м. Медведково) — Пироговский (Посёлок Пироговский)",\
"interval":\
{\
"density": "маршрутное такси раз в 15-30 минут",\
"end_time": "2017-07-10T21:30:00",\
"begin_time": "2017-07-10T06:00:00"\
},\
"number": "502 (м/т)",\
"short_title": "Москва (м. Медведково) — Пироговский (Посёлок Пироговский)",\
"carrier": null,\
"transport_type": "bus",\
"vehicle": null,\
"transport_subtype":\
{\
"color": "#ff0000",\
"code": "bus",\
"title": "Автобус"\
},\
"express_type": null\
},\
"is_fuzzy": false,\
"days": "ежедневно",\
"stops": "",\
"terminal": null,\
"platform": ""\
},\
...\
],
"schedule_direction":
{
"code": "на Москву",
"title": "на Москву"
},
"directions":
[\
{\
"code": "arrival",\
"title": "прибытие"\
},\
{\
"code": "на Москву",\
"title": "на Москву"\
},\
{\
"code": "all",\
"title": "все направления"\
}\
]
}
```
#### Описание элементов JSON
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `date` | Строка | Дата, на которую получен список рейсов.<br>Принимает значение `null`, если в запросе не указан параметр `date`. |
| `pagination` | Объект | Информация о постраничном выводе найденных рейсов. |
| `station` | Объект | Информация об указанной в запросе станции. |
| `schedule` | Массив | Список рейсов. |
| `schedule_direction` | Объект | Код и название запрошенного направления рейсов.<br>Элемент включается в ответ, если в запросе указан параметр `direction`. |
| `directions` | Объект | Коды и названия возможных направлений движения электричек по станции.<br>Элемент включается в ответ, если в запросе указан параметр `transport_types` со значением `suburban`. |
**Элементы объекта**`pagination`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `total` | Число | Общее количество рейсов, удовлетворяющих условиям поиска. |
| `limit` | Число | Ограничение на количество рейсов, которые Яндекс Расписания возвращают в ответ на запрос (заданное в параметре `limit`).<br>Значение по умолчанию — 100. |
| `offset` | Число | Смещение относительно первого результата поиска, заданное в параметре `offset`.<br>Значение по умолчанию — 0. |
**Элементыобъекта**`station`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `station_type` | Строка | Тип станции.<br>Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
| `title` | Строка | Название станции. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `codes` | Объект | Список кодов станции в системах кодирования, заданных параметром `show_systems`. |
| `transport_type` | Строка | Тип транспорта, обслуживаемый станцией.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
**Элементыобъекта**`schedule`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days). |
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `thread` | Объект | Информация о нитке. |
| `is_fuzzy` | Булевый | Признак неточности времени отправления и времени прибытия. Возможные значения:<br>- `true` — время прибытия и время отправления указаны неточно;<br>- `false` — время прибытия и время отправления указан точно. |
| `days` | Строка | Дни курсирования нитки. |
| `stops` | Строка (не более 1000 символов) | Станции следования рейса, на которых совершается остановка. Описывается в свободной форме. Например, значение `везде` значит, что остановка совершается на всех станциях следования.<br>Пустая строка значит, что нитка нигде не останавливается между начальной и конечной станциями. |
| `departure` | Строка | Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
**Элементыобъекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `esr` | Строка | Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0). |
**Элементыобъекта**`schedule_direction`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Строка | Код направления.<br>Может принимать значения:<br>- `arrival` — код направления с названием «прибытие», для рейсов электричек, прибывающих на станцию.<br>- `на Москву` (`на Шалю` и т. д.) — код направления с названием, для электричек курсирующих по такому направлению.<br>- `all` — код направления с названием «все направления», для рейсов, отправляющихся по всем возможным направлениям. |
| `title` | Строка | Название направления.<br>Возможные значения: «прибытие», «все направления», «на Москву», «на Шалю» и т. д. |
**Элементыобъекта**`thread`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
| `title` | Строка | Название нитки. Составляется из полных названий первой и последней станций следования. |
| `number` | Строка | Номер рейса. |
| `short_title` | Строка | Короткое название нитки. Составляется из коротких названий первой и последней станций следования. |
| `carrier` | Объект | Информация о перевозчике. |
| `transport_type` | Строка | Тип транспортного средства. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет.<br>По умолчанию возвращается список рейсов по всем типам транспортных средств. |
| `vehicle` | Строка | Название транспортного средства. |
| `transport_subtype` | Строка | Информация о подтипе транспортного средства. |
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ transport\_type возвращен со значением suburban), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
**Элементыобъекта**`codes`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
**Элементыобъекта**`transport_subtype`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `color` | Строка | Основной цвет транспортного средства в шестнадцатеричном формате. |
| `code` | Строка | Код подтипа транспорта для типа, указанного в элементе `transport_type`. Подтип может совпадать с типом (например, для обычной электрички указывается тип `suburban` и подтип `suburban`).<br>Другие возможные значения:<br>- `helicopter` — вертолет (для типа `plane`);<br>- `rex` — экспресс РЭКС (для типа `suburban`);<br>- `sputnik` — «Спутник» (для типа `suburban`);<br>- `skiarrow` — «Лыжная стрела» (для типа `suburban`);<br>- `shezh` — «Снежинка» (для типа `suburban`);<br>- `skirus` — «Лыжня России» (для типа `suburban`);<br>- `city` — городская электричка (для типа `suburban`);<br>- `kalina` — «Калина красная» (для типа `suburban`);<br>- `vostok` — «Восток» (для типа `suburban`);<br>- `prostoryaltaya` — «Просторы Алтая» (для типа `suburban`);<br>- `14vag` — состав из 14 вагонов (для типа `suburban`);<br>- `last` — «Ласточка» (для типа `suburban`);<br>- `exprdal` — экспресс с билетами на конкретные места (для типа `suburban`);<br>- `volzhex` — «Волжский экспресс» (для типа `suburban`);<br>- `stdplus` — электрички типа «стандарт плюс» (для типа `suburban`);<br>- `express` — экспресс (для типа `suburban`);<br>- `skor` — ускоренный поезд (для типа `suburban`);<br>- `fiztekh` — Физтех.Электричка (для типа `suburban`);<br>- `vag6` — состав из 6 вагонов (для типа `suburban`);<br>- `river—` речной транспорт (для типа `water`);<br>- `sea` — морской транспорт (для типа `water`). |
| `title` | Строка | Описание подтипа транспорта на естественном языке. |
**Элементыобъекта**`carrier`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
| `codes` | Объект | Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
| `title` | Строка | Название перевозчика. |
**Элементыобъекта**`directions`
| | | |
| --- | --- | --- |
| **Элемент JSON** | **Тип** | **Описание** |
| `code` | Строка | Код направления. Может указываться в свободной форме, или одним из следующих идентификаторов:<br>- `all` — все направления для указанной станции;<br>- `arrival` — только прибывающие направления;<br>- `departure` — только отправляющиеся направления. |
| `title` | Строка | Название направления (расшифровка кода) в свободной форме. Если значение элемента `code` не является одним из идентификаторов, то название и код направления обычно совпадают (например, «на Москву»). |
```
<response>
<pagination>
<total>162</total>
<limit>100</per_page>
<offset>0</page_count>
</pagination>
<schedule>
<except_days>xsi:nil="true"</except_days>
<arrival>2017-02-27T00:04:00+03:00</arrival>
<thread>
<carrier>
<code>153</code>
<codes>
<icao>xsi:nil="true"</icao>
<sirena>xsi:nil="true"</sirena>
<iata>xsi:nil="true"</iata>
</codes>
<title>Центральная пригородная пассажирская компания</title>
</carrier>
<transport_type>suburban</transport_type>
<uid>6038A_9607404_g13_af</uid>
<title{thread}>Екатеринбург-Пасс. - аэропорт Кольцово</title>
<transport_subtype>
<color>#FF7F44</color>
<code>suburban</code>
<title>Пригородный поезд</title>
</transport_subtype>
<vehicle>xsi:nil="true"</vehicle>
<number>6038</number>
<short_title{thread}>Екатеринбург-Пасс. - а/п Кольцово</short_title>
<express_type/>
</thread>
<platform></platform>
<days>ежедневно</days>
<stops>везде</stops>
<departure>2017-02-27T00:05:00+03:00</departure>
<terminal>xsi:nil="true"</terminal>
<is_fuzzy>false</is_fuzzy>
</schedule>
<schedule_direction>
<code>all</code>
<title>все направления</title>
</schedule_direction>
<direction>
<code>arrival</code>
<title>прибытие</title>
</direction>
<direction>
<code>на Москву</code>
<title>на Москву</title>
</direction>
<direction>
<code>на Можайск</code>
<title>на Можайск</title>
</direction>
<direction>
<code>all</code>
<title>все направления</title>
</direction>
<station>
<codes>
<yandex>s9601728</yandex>
<esr>181704</esr>
</codes>
<title{station}>Кольцово</title>
<station_type>аэропорт</station_type>
<popular_title{station}/>
<short_title{station}/>
<code{station}>s9600370</code>
<transport_type>plane</transport_type>
<type>station</type>
</station>
<date>2017-09-03</date>
</response>
```
#### Описание элементов XML
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `pagination` | | Информация о постраничном выводе найденных рейсов. |
| `schedule` | | Один из найденных рейсов. |
| `schedule_direction` | | Код и название запрошенного направления рейсов.<br>Элемент включается в ответ, если в запросе указан параметр `direction`. |
| `direction` | | Одно из направлений, на котором лежит станция. |
| `station` | | Информация об указанной в запросе станции. |
| `date` | Строка | Дата, на которую получен список рейсов. |
**Элементы, вложенные в**`station`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `codes` | | Список кодов станции в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
| `title` | Строка | Название станции. |
| `popular_title` | Строка | Общепринятое название станции. |
| `short_title` | Строка | Короткое название станции. |
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
| `station_type` | Строка | Тип станции.<br>Возможные значения:<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
**Элементы, вложенные в**`codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `express` | Строка | Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/). |
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
| `esr` | Строка | Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0). |
**Элементы, вложенные в**`schedule`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `days` | Строка | Дни курсирования нитки. |
| `stops` | Строка (не более 1000 символов) | Станции следования рейса, на которых совершается остановка. Описывается в свободной форме. Например, значение `везде` означает, что остановка совершается на всех станциях следования.<br>Пустой элемент означает, что станций следования, на которых совершается остановка, нет. |
| `thread` | | Элемент, содержащий информацию о нитке. |
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `is_fuzzy` | Булевый | Признак неточности времени отправления и времени прибытия. Возможные значения:<br>- `true` — время прибытия и время отправления указаны неточно;<br>- `false` — время прибытия и время отправления указан точно. |
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
| `departure` | Строка | Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
| `direction` | Строка (не более 100 символов) | Направление, в котором рейс отправляется от станции согласно расписанию нитки.<br>Принимает значение `прибытие`, если станция — конечная для данной нитки. |
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days). |
**Элементы, вложенные в**`thread`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `carrier` | | Элемент, содержащий информацию о перевозчике. |
| `transport_type` | Строка | Тип транспорта, обслуживаемый станцией.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
| `title` | Строка | Название нитки. |
| `vehicle` | Строка | Название транспортного средства. |
| `number` | Строка | Номер рейса. |
| `short_title` | Строка | Название нитки, состоящее из коротких названий станций первой и последней станций следования. |
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
**Элементы, вложенные в**`carrier`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
| `codes` | | Элемент, содержащий список кодов перевозчика в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
| `title` | Строка | Название перевозчика. |
**Элементы, вложенные в**`codes`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
**Элементы, вложенные в**`direction`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Строка | Код направления.<br>Может принимать значения:<br>- `arrival` — код направления с названием «прибытие».<br> <br> Рейсы электричек, прибывающих на станцию.<br> <br>- `на Москву` (`на Шалю` и т. д.) — код направления с названием «на Москву», «на Шалю» и т. д.<br> <br> Рейсы электричек, отправляющихся по направлению с названием «на Москву» («на Шалю» и т. д.).<br> <br>- `all` — код направления с названием «все направления».<br> <br> Рейсы электричек, отправляющихся по всем возможным направлениям. |
| `title` | Строка | Название направления.<br>Возможные значения: «прибытие», «все направления», «на Москву», «на Шалю» и т. д. |
**Элементы, вложенные в**`directions`
| | | |
| --- | --- | --- |
| **Элемент XML** | **Тип** | **Описание** |
| `code` | Строка | Код направления.<br>Возможные значения:<br>- `arrival` — код направления «прибытие».<br> <br> Необходимо использовать в качестве значения входного параметра [`direction`](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format/query-schedule-param-direction) в запросе для выдачи рейсов электричек, прибывающих на станцию.<br> <br>- `на Москву` (`на Шалю` и т. д.) — код направления «на Москву», «на Шалю» и т. д.<br> <br> Необходимо использовать в качестве значения входного параметра [`direction`](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format/query-schedule-param-direction) в запросе для выдачи рейсов электричек, отправляющихся по направлению «на Москву» («на Шалю» и т. д.).<br> <br>- `all` — код направления «все направления».<br> <br> Необходимо использовать в качестве значения входного параметра [`direction`](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station#format/query-schedule-param-direction) в запросе для выдачи рейсов электричек, отправляющихся по всем возможным для станции направлениям. |
| `title` | Строка | Название направления в свободной форме.<br>Возможные значения: «прибытие», «все направления», «на Москву», «на Шалю» и т. д. |
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
```
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
```
Код станции. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
По умолчанию ответ возвращается для значения `ru_RU`.
Поддерживаемые коды языков:
- `ru` — русский;
- `uk` — украинский.
Поддерживаемые коды стран:
- `RU` — Россия;
- `UA` — Украина.
Формат ответа. Поддерживаемые значения:
- `json` (по умолчанию);
- `xml`.
Дата, на которую необходимо получить список рейсов. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.
Если в запросе указана конкретная дата, в выдаче будут показаны все будущие рейсы, в том числе с пересадками.
Если запрос передан без даты, в выдаче будут показаны только прямые рейсы на все даты. В этом случае рейсы с пересадками не попадут в выдачу.
Тип транспортного средства. Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — морской транспорт;
- `helicopter` — вертолет.
По умолчанию возвращается список рейсов по всем типам транспортных средств.
Событие, для которого нужно отфильтровать нитки в расписании.
Поддерживаемые значения:
- `departure` — включить в ответ только отправляющиеся со станции нитки (по умолчанию);
- `arrival` — включить в ответ только прибывающие на станцию нитки. \|\|
[Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код станции отправления и код станции прибытия (параметры `from`, `to`) в запросе. Возможные значения:
- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;
- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);
- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));
- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);
- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний.
Система кодирования, коды которой следует добавить к описанию станций в результатах поиска (элемент codes, вложенный в элементы from и to).
Поддерживаемые значения:
yandex (значение по умолчанию) — система кодирования Яндекс Расписаний;
esr — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
Часовой пояс, для которого следует указывать даты и времена в ответе. Если параметр не передан, каждая дата и время в ответе будут указаны в часовом поясе соответствующей станции.
Часовые пояса следует указывать с помощью идентификаторов [базы данных tz](https://ru.wikipedia.org/wiki/Tz_database). В английской Википедии приведен список идентификаторов из последней версии этой базы данных (в столбце «TZ» таблицы).
Код направления, по которому необходимо получить список рейсов электричек по станции (например, «arrival», «all» или «на Москву»).
Параметр `direction` игнорируется, если значение параметра `transport_types` отлично от `suburban`.
Доступные для станции коды направлений можно получить, запросив расписание на любую дату без параметра `direction`, но с параметром `transport_types=suburban`. Список направлений возвращается в элементе ответа `directions`.
**Тип**
Строка
**Описание**
Код пункта прибытия в системе кодирования Яндекс Расписаний.
**Тип**
Объект
**Описание**
Информация о постраничном выводе найденных рейсов.
**Тип**
Число
**Описание**
Общее количество рейсов, удовлетворяющих условиям поиска.
**Тип**
Число
**Описание**
Ограничение на количество рейсов, которые Яндекс Расписания возвращают в ответ на запрос (заданное в параметре `limit`).
Значение по умолчанию — 100.
**Тип**
Число
**Описание**
Смещение относительно первого результата поиска, заданное в параметре `offset`.
Значение по умолчанию — 0.
**Тип**
Строка
**Описание**
Дата, на которую получен список рейсов, в формате «YYYY-MM-DD».
**Тип**
Строка
**Описание**
Вид пункта отправления.
Возможные значения:
- `station` — станция;
- `settlement` — поселение.
**Тип**
Строка
**Описание**
Название пункта отправления.
**Тип**
Строка
**Описание**
Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
**Тип**
Строка
**Описание**
Тип отправляющегося транспортного средства.
Возможные значения:
- `plane` — самолет;
- `train` — поезд;
- `suburban` — электричка;
- `bus` — автобус;
- `water` — водный транспорт;
- `helicopter` — вертолет.
**Тип**
Объект
**Описание**
Информация о [нитке](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#intervalthread) рейса.
**Тип**
Объект
**Описание**
Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.
**Тип**
Объект
**Описание**
Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)).
**Тип**
Строка
**Описание**
Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0).
**Тип**
Объект
**Описание**
Информация о подтипе транспортного средства.
**Тип**
Строка
**Описание**
Основной цвет транспортного средства в шестнадцатеричном формате.
**Тип**
Строка
**Описание**
Название транспортного средства.
**Тип**
Строка
**Описание**
Номер рейса.
**Тип**
Строка
**Описание**
Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.
Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:
- `express` — экспресс-рейс;
- `aeroexpress` — рейс, курсирующий между городом и аэропортом.
**Тип**
Строка
**Описание**
Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
**Тип**
Строка (не более 1000 символов)
**Описание**
Станции следования рейса, на которых совершается остановка. Описывается в свободной форме. Например: значение `везде` значит, что остановка совершается на всех станциях следования.
Пустая строка значит, что по пути следования остановок нет.
**Тип**
Массив
**Описание**
Список рейсов.
**Тип**
Строка
**Описание**
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
**Тип**
Объект
**Описание**
Информация о перевозчике.
**Тип**
Строка
**Описание**
Платформа или путь, с которого отправляется рейс (например, «3 путь»).
Пустая строка значит, что информации о платформе или пути нет.
**Тип**
Строка
**Описание**
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
**Тип**
Строка
**Описание**
Терминал аэропорта (например, «D»).
Принимает значение `null`, если информации о терминале нет.
**Тип**
Булевый
**Описание**
Признак неточности времени отправления и времени прибытия. Возможные значения:
- `true` — время прибытия и время отправления указаны неточно;
- `false` — время прибытия и время отправления указан точно.
**Тип**
Объект
**Описание**
Код и название запрошенного направления рейсов.
Элемент включается в ответ, если в запросе указан параметр `direction`.
**Тип**
**Описание**
Одно из направлений, на котором лежит станция.
**Тип**
Объект
**Описание**
Информация об указанной в запросе станции.
**Тип**
Строка
**Описание**
Код станции в системе кодирования Яндекс Расписаний.
**Тип**
Строка
**Описание**
Код станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
**Тип**
Строка
**Описание**
Тип станции.
Возможные значения:
- `station` — станция;
- `platform` — платформа;
- `stop` — остановочный пункт;
- `checkpoint` — блок-пост;
- `post` — пост;
- `crossing` — разъезд;
- `overtaking_point` — обгонный пункт;
- `train_station` — вокзал;
- `airport` — аэропорт;
- `bus_station` — автовокзал;
- `bus_stop` — автобусная остановка;
- `unknown` — станция без типа;
- `port` — порт;
- `port_point` — портпункт;
- `wharf` — пристань;
- `river_port` — речной вокзал;
- `marine_station` — морской вокзал.