624 lines
22 KiB
Markdown
624 lines
22 KiB
Markdown
Список всех доступных станций
|
||
|
||
# Список всех доступных станций
|
||
|
||
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/stations-list#query)
|
||
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/stations-list#emails-detailed)
|
||
|
||
Ресурс содержит полный список станций, информацию о которых предоставляют Яндекс Расписания. Список структурирован географически: ответ содержит список стран со вложенными списками регионов и населенных пунктов, в которых находятся станции.
|
||
|
||
Размер возвращаемого JSON-документа — около 40 МБ.
|
||
|
||
## Синтаксис запроса
|
||
|
||
```
|
||
https://api.rasp.yandex-net.ru/v3.0/stations_list/ ?
|
||
apikey=<ключ>
|
||
[& format=<формат>]
|
||
[& lang=<язык>]
|
||
```
|
||
|
||
Пример запроса:
|
||
|
||
```
|
||
https://api.rasp.yandex-net.ru/v3.0/stations_list/?apikey={ключ}&lang=ru_RU&format=json
|
||
```
|
||
|
||
Входные параметры:
|
||
|
||
**Обязательные параметры**
|
||
|
||
| | |
|
||
| --- | --- |
|
||
| **Параметр** | **Описание** |
|
||
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
|
||
|
||
**Необязательные параметры**
|
||
|
||
| | |
|
||
| --- | --- |
|
||
| **Параметр** | **Описание** |
|
||
| `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`. |
|
||
|
||
## Структура ответа
|
||
|
||
Ответ оформлен в виде набора вложенных массивов: на верхнем уровне перечислены страны, в описании каждой страны — регионы, в каждом регионе — города, в каждом городе — станции.
|
||
|
||
Часть ответа в различных форматах показана в примерах.
|
||
|
||
Пример ответа в формате JSON
|
||
|
||
Пример ответа в формате XML
|
||
|
||
```
|
||
{
|
||
"countries":
|
||
[\
|
||
{\
|
||
"regions":\
|
||
[\
|
||
{\
|
||
"settlements":\
|
||
[\
|
||
{\
|
||
"title": "",\
|
||
"codes": {},\
|
||
"stations":\
|
||
[\
|
||
{\
|
||
"direction": "",\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "s9628674"\
|
||
},\
|
||
"station_type": "аэропорт",\
|
||
"title": "Бермуды",\
|
||
"longitude": -64.678703,\
|
||
"transport_type": "Самолёт",\
|
||
"latitude": 32.364041\
|
||
}\
|
||
]\
|
||
}\
|
||
],\
|
||
"codes": {},\
|
||
"title": ""\
|
||
}\
|
||
],\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "l21546"\
|
||
},\
|
||
"title": "Бермудские острова"\
|
||
},\
|
||
{\
|
||
"regions":\
|
||
[\
|
||
{\
|
||
"settlements":\
|
||
[\
|
||
{\
|
||
"title": "Банжул",\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "c21012"\
|
||
},\
|
||
"stations":\
|
||
[\
|
||
{\
|
||
"direction": "",\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "s9628059"\
|
||
},\
|
||
"station_type": "аэропорт",\
|
||
"title": "Юндум",\
|
||
"longitude": -16.652222,\
|
||
"transport_type": "Самолёт",\
|
||
"latitude": 13.338056\
|
||
}\
|
||
]\
|
||
}\
|
||
],\
|
||
"codes": {},\
|
||
"title": ""\
|
||
}\
|
||
],\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "l21010"\
|
||
},\
|
||
"title": "Гамбия"\
|
||
}\
|
||
{\
|
||
"regions":\
|
||
[\
|
||
{\
|
||
"settlements":\
|
||
[\
|
||
{\
|
||
"title": "Новая Уситва",\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "c54722"\
|
||
},\
|
||
"stations":\
|
||
[\
|
||
{\
|
||
"direction": "",\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "s9855938"\
|
||
},\
|
||
"station_type": "автобусная остановка",\
|
||
"title": "Новая Уситва",\
|
||
"longitude": 28.1280804651562,\
|
||
"transport_type": "Автобус",\
|
||
"latitude": 57.4583284320784\
|
||
}\
|
||
]\
|
||
},\
|
||
{\
|
||
"title": "Касторное",\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "c22754"\
|
||
},\
|
||
"stations":\
|
||
[\
|
||
{\
|
||
"direction": "Елецкое",\
|
||
"codes":\
|
||
{\
|
||
"esr_code": "595401",\
|
||
"yandex_code": "s9605487"\
|
||
},\
|
||
"station_type": "станция",\
|
||
"title": "Касторная-Новая",\
|
||
"longitude": 38.123675,\
|
||
"transport_type": "Поезд",\
|
||
"latitude": 51.780828\
|
||
}\
|
||
]\
|
||
}\
|
||
],\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "r10705"\
|
||
},\
|
||
"title": "Курская область"\
|
||
}\
|
||
],\
|
||
"codes":\
|
||
{\
|
||
"yandex_code": "l225"\
|
||
},\
|
||
"title": "Россия"\
|
||
}\
|
||
]
|
||
}
|
||
```
|
||
|
||
#### Описание элементов JSON
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `countries` | Массив | Список стран. |
|
||
|
||
**Элементыобъекта**`countries`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `regions` | Массив | Список регионов страны. |
|
||
| `codes` | Объект | Коды страны. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
|
||
| `title` | Строка | Название страны. |
|
||
|
||
**Элементыобъекта**`regions`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `settlements` | Массив | Список населенных пунктов региона. |
|
||
| `codes` | Объект | Коды региона. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
|
||
| `title` | Строка | Название региона. |
|
||
|
||
**Элементыобъекта**`settlements`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `title` | Строка | Название населенного пункта. |
|
||
| `codes` | Объект | Коды населенного пункта. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
|
||
| `stations` | Объект | Список станций в населенном пункте. |
|
||
|
||
**Элементыобъекта**`stations`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `direction` | Строка | Направление движения поездов, на котором находится станция.<br>Значение пусто, если станция не железнодорожная. |
|
||
| `codes` | Объект | Список кодов станции. |
|
||
| `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` — морской вокзал. |
|
||
| `title` | Строка | Название станции. |
|
||
| `longitude` | Число | Долгота станции. |
|
||
| `transport_type` | Строка | Тип транспорта, следующего через станцию.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет. |
|
||
| `latitude` | Число | Широта станции. |
|
||
|
||
**Элементыобъекта**`station/codes`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `esr_code` | Строка | Код железнодорожной станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%C5%E4%E8%ED%E0%FF_%F1%E5%F2%E5%E2%E0%FF_%F0%E0%E7%EC%E5%F2%EA%E0). |
|
||
| `yandex_code` | Строка | Код в системе кодирования Яндекс Расписаний. |
|
||
|
||
```
|
||
<response>
|
||
<country>
|
||
<title>Бермудские острова</title>
|
||
<codes>
|
||
<yandex_code>l21546</yandex_code>
|
||
</codes>
|
||
<region>
|
||
<title/>
|
||
<codes/>
|
||
<settlement>
|
||
<title/>
|
||
<codes/>
|
||
<station>
|
||
<title>Бермуды</title>
|
||
<longitude>-64.678703</longitude>
|
||
<latitude>32.364041</latitude>
|
||
<transport_type>Самолёт</transport_type>
|
||
<station_type>аэропорт</station_type>
|
||
<codes>
|
||
<yandex_code>s9628674</yandex_code>
|
||
</codes>
|
||
</station>
|
||
</settlement>
|
||
</region>
|
||
</country>
|
||
<country>
|
||
<title>Гамбия</title>
|
||
<codes>
|
||
<yandex_code>l21010</yandex_code>
|
||
</codes>
|
||
<region>
|
||
<title/>
|
||
<codes/>
|
||
<settlement>
|
||
<title>Банжул</title>
|
||
<codes>
|
||
<yandex_code>c21012</yandex_code>
|
||
</codes>
|
||
<station>
|
||
<title>Юндум</title>
|
||
<longitude>-16.652222</longitude>
|
||
<latitude>13.338056</latitude>
|
||
<transport_type>Самолёт</transport_type>
|
||
<station_type>аэропорт</station_type>
|
||
<codes>
|
||
<yandex_code>s9628059</yandex_code>
|
||
</codes>
|
||
</station>
|
||
</settlement>
|
||
</region>
|
||
</country>
|
||
<country>
|
||
<title>Россия</title>
|
||
<codes>
|
||
<yandex_code>l225</yandex_code>
|
||
</codes>
|
||
<region>
|
||
<title>Псковская область</title>
|
||
<codes>
|
||
<yandex_code>r10926</yandex_code>
|
||
</codes>
|
||
<settlement>
|
||
<title>Новая Уситва</title>
|
||
<codes>
|
||
<yandex_code>c54722</yandex_code>
|
||
</codes>
|
||
<station>
|
||
<title>Новая Уситва</title>
|
||
<longitude>28.1280804652</longitude>
|
||
<latitude>57.4583284321</latitude>
|
||
<transport_type>Автобус</transport_type>
|
||
<station_type>автобусная остановка</station_type>
|
||
<codes>
|
||
<yandex_code>s9855938</yandex_code>
|
||
</codes>
|
||
</station>
|
||
<station>
|
||
<title>Касторная-Новая</title>
|
||
<longitude>38.123675</longitude>
|
||
<latitude>51.780828</latitude>
|
||
<transport_type>Поезд</transport_type>
|
||
<station_type>станция</station_type>
|
||
<direction>Елецкое</direction>
|
||
<codes>
|
||
<esr_code>595401</esr_code>
|
||
<yandex_code>s9605487</yandex_code>
|
||
</codes>
|
||
</station>
|
||
</settlement>
|
||
</region>
|
||
</country>
|
||
</response>
|
||
```
|
||
|
||
#### Описание элементов XML
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент XML** | **Тип** | **Описание** |
|
||
| `country` | | Страна, с вложенными описаниями регионов. |
|
||
|
||
**Элементыобъекта**`country`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент XML** | **Тип** | **Описание** |
|
||
| `region` | Массив | Один из регионов страны. |
|
||
| `codes` | | Коды страны. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
|
||
| `title` | Строка | Название страны. |
|
||
|
||
**Элементыобъекта**`region`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент XML** | **Тип** | **Описание** |
|
||
| `settlement` | | Один из населенных пунктов региона. |
|
||
| `codes` | Объект | Коды региона. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
|
||
| `title` | Объект | Название региона. |
|
||
|
||
**Элементыобъекта**`settlement`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент XML** | **Тип** | **Описание** |
|
||
| `title` | Объект | Название населенного пункта. |
|
||
| `codes` | Объект | Коды населенного пункта. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`). |
|
||
| `station` | Объект | Одна из станций в населенном пункте. |
|
||
|
||
**Элементыобъекта**`station`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент XML** | **Тип** | **Описание** |
|
||
| `direction` | Строка | Направление движения поездов, на котором находится станция.<br>Значение пусто, если станция не железнодорожная. |
|
||
| `codes` | Объект | Список кодов станции. |
|
||
| `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` — морской вокзал. |
|
||
| `title` | Объект | Название станции. |
|
||
| `longitude` | Число | Долгота станции. |
|
||
| `transport_type` | Объект | Тип транспорта, следующего через станцию.<br>Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — морской транспорт;<br>- `helicopter` — вертолет. |
|
||
| `latitude` | Число | Широта станции. |
|
||
|
||
**Элементы, вложенные в элемент**`station/codes`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент XML** | **Тип** | **Описание** |
|
||
| `yandex_code` | Строка | Код в системе кодирования Яндекс Расписаний. |
|
||
| `esr_code` | Строка | Код железнодорожной станции в системе кодирования [ЕСР](https://ru.wikipedia.org/wiki/%C5%E4%E8%ED%E0%FF_%F1%E5%F2%E5%E2%E0%FF_%F0%E0%E7%EC%E5%F2%EA%E0). |
|
||
|
||
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
|
||
|
||
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
|
||
|
||
```
|
||
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
|
||
```
|
||
|
||
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
||
|
||
По умолчанию ответ возвращается для значения `ru_RU`.
|
||
|
||
Поддерживаемые коды языков:
|
||
|
||
- `ru` — русский;
|
||
- `uk` — украинский.
|
||
|
||
|
||
|
||
|
||
Поддерживаемые коды стран:
|
||
- `RU` — Россия;
|
||
- `UA` — Украина.
|
||
|
||
Формат ответа. Поддерживаемые значения:
|
||
|
||
- `json` (по умолчанию);
|
||
- `xml`.
|
||
|
||
**Тип**
|
||
|
||
Массив
|
||
|
||
**Описание**
|
||
|
||
Список населенных пунктов региона
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Название населенного пункта.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Направление движения поездов, на котором находится станция.
|
||
|
||
Значение пусто, если станция не железнодорожная.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Код в системе кодирования Яндекс Расписаний.
|
||
|
||
**Тип**
|
||
|
||
**Описание**
|
||
|
||
Страна, с вложенными описаниями регионов.
|
||
|
||
**Тип**
|
||
|
||
Объект
|
||
|
||
**Описание**
|
||
|
||
Коды страны. На данный момент используется только система кодирования Яндекс Расписаний (`yandex_code`).
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Название страны.
|
||
|
||
**Тип**
|
||
|
||
Объект
|
||
|
||
**Описание**
|
||
|
||
Название региона.
|
||
|
||
**Тип**
|
||
|
||
Объект
|
||
|
||
**Описание**
|
||
|
||
Название населенного пункта.
|
||
|
||
**Тип**
|
||
|
||
Объект
|
||
|
||
**Описание**
|
||
|
||
Название станции.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Код в системе кодирования Яндекс Расписаний.
|
||
|
||
**Тип**
|
||
|
||
Массив
|
||
|
||
**Описание**
|
||
|
||
Один из регионов страны.
|
||
|
||
**Тип**
|
||
|
||
**Описание**
|
||
|
||
Один из населенных пунктов региона.
|
||
|
||
**Тип**
|
||
|
||
Объект
|
||
|
||
**Описание**
|
||
|
||
Одна из станций в населенном пункте.
|
||
|
||
**Тип**
|
||
|
||
Число
|
||
|
||
**Описание**
|
||
|
||
Долгота станции.
|
||
|
||
**Тип**
|
||
|
||
Число
|
||
|
||
**Описание**
|
||
|
||
Широта станции.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Тип транспорта, следующего через станцию.
|
||
|
||
Возможные значения:
|
||
|
||
- `plane` — самолет;
|
||
- `train` — поезд;
|
||
- `suburban` — электричка;
|
||
- `bus` — автобус;
|
||
- `water` — морской транспорт;
|
||
- `helicopter` — вертолет.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Тип станции.
|
||
|
||
Возможные значения:
|
||
|
||
- `station` — станция;
|
||
- `platform` — платформа;
|
||
- `stop` — остановочный пункт;
|
||
- `checkpoint` — блок-пост;
|
||
- `post` — пост;
|
||
- `crossing` — разъезд;
|
||
- `overtaking_point` — обгонный пункт;
|
||
- `train_station` — вокзал;
|
||
- `airport` — аэропорт;
|
||
- `bus_station` — автовокзал;
|
||
- `bus_stop` — автобусная остановка;
|
||
- `unknown` — станция без типа;
|
||
- `port` — порт;
|
||
- `port_point` — портпункт;
|
||
- `wharf` — пристань;
|
||
- `river_port` — речной вокзал;
|
||
- `marine_station` — морской вокзал.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Направление движения поездов, на котором находится станция.
|
||
|
||
Значение пусто, если станция не железнодорожная.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Код железнодорожной станции в системе кодирования [ЕСР](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).
|