24 KiB
Список ближайших станций
Список ближайших станций
Запрос позволяет получить список станций, находящихся в указанном радиусе от указанной точки. Максимальное количество возвращаемых станций — 50.
Точка определяется географическими координатами (широтой и долготой) согласно WGS84.
Синтаксис запроса
https://api.rasp.yandex-net.ru/v3.0/nearest_stations/ ?
apikey=<ключ>
& lat=<широта>
& lng=<долгота>
& distance=<радиус охвата>
& [lang=<язык>]
& [offset=<сдвиг относительно первого рейса в ответе>]
& [limit=<ограничение на количество рейсов в ответе>]
& [station_types=<тип станции>]
& [transport_types=<тип транспортного средства>]
& [format=<формат>]
Пример запроса:
https://api.rasp.yandex-net.ru/v3.0/nearest_stations/?apikey={ключ}&format=json&lat=50.440046&lng=40.4882367&distance=50&lang=ru_RU
Входные параметры:
Обязательные параметры
| Параметр | Описание |
apikey |
Ключ доступа к API. Параметр можно не передавать, если ключ доступа указан в заголовке Authorization, например:<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br> |
lat |
Широта согласно WGS84. |
lng |
Долгота согласно WGS84. |
distance |
Радиус, в котором следует искать станции, в километрах. |
Необязательные параметры
| Параметр | Описание |
lang |
Язык возвращаемой информации, в формате <код языка>_<код страны>. Поддерживаемые коды языка описаны стандартом ISO 639, коды стран — стандартом ISO 3166. По умолчанию ответ возвращается для значения ru_RU.Поддерживаемые коды языков: - ru — русский;- uk — украинский.Поддерживаемые коды стран: - RU — Россия;- UA — Украина. |
format |
Формат ответа. Поддерживаемые значения: - json (по умолчанию);- xml. |
station_types |
Типы запрашиваемых станций (несколько типов можно перечислить через запятую). Поддерживаемые значения: - station — станция;- platform — платформа;- stop — остановочный пункт;- checkpoint — блок-пост;- post — пост;- crossing — разъезд;- overtaking_point — обгонный пункт;- train_station — вокзал;- airport — аэропорт;- bus_station — автовокзал;- bus_stop — автобусная остановка;- unknown — станция без типа;- port — порт;- port_point — портпункт;- wharf — пристань;- river_port — речной вокзал;- marine_station — морской вокзал. |
transport_types |
Типы транспортного средства, для которых нужно искать станции. Несколько типов одновременно можно указать через запятую, например, plane,train,bus. Поддерживаемые значения: - plane — самолет;- train — поезд;- suburban — электричка;- bus — автобус;- sea — морской транспорт;- river — речной транспорт;- helicopter — вертолет. |
offset |
Смещение относительно первого результата поиска. Например, если вам не нужны первые 10 результатов поиска, задайте для параметра значение «10». Значение по умолчанию — 0. |
limit |
Максимальное количество результатов поиска в ответе. Значение по умолчанию — 100. |
Структура ответа
Ответ представляет собой список станций, находящихся в указанном радиусе от указанной точки с информацией по каждой станции.
Пример ответа в формате JSON
Пример ответа в формате XML
{
"pagination":
{
"total": 35,
"limit": 100,
"offset": 0
},
"stations":
[\
{\
"distance": 24.74255931084455,\
"code": "s9637063",\
"station_type": "bus_station",\
"station_type_name": "автовокзал",\
"type_choices": {\
"schedule": {\
"desktop_url": "https://rasp.yandex.ru/station/9761931/schedule",\
"touch_url": "https://t.rasp.yandex.ru/station/9761931/schedule"\
}\
},\
"title": "Павловск",\
"popular_title": "",\
"short_title": "",\
"transport_type": "bus",\
"lat": 50.4516962252837,\
"lng": 40.1392928134917,\
"type": "station"\
},\
...\
]
}
Описание элементов JSON
| Элемент JSON | Тип | Описание |
pagination |
Массив | Информация о постраничном выводе. |
stations |
Массив | Список станций. |
Элементыобъектаpagination
| Элемент JSON | Тип | Описание |
total |
Число | Общее количество станций, удовлетворяющих условиям поиска. |
limit |
Число | Ограничение на количество станций, которые Яндекс Расписания возвращают в ответ на запрос. Ограничение можно задать в параметре limit.Значение по умолчанию — 100. |
offset |
Число | Смещение относительно первого результата поиска. Смещение можно задать в параметре offset.Значение по умолчанию — 0. |
Элементыобъектаstations
| Элемент JSON | Тип | Описание |
distance |
Число | Расстояние от указанной в запросе точки до полученной в ответе станции. |
code |
Строка | Код станции в системе кодирования Яндекс Расписаний. |
station_type |
Строка | Тип станции. Возможные значения: - station — станция;- platform — платформа;- stop — остановочный пункт;- checkpoint — блок-пост;- post — пост;- crossing — разъезд;- overtaking_point — обгонный пункт;- train_station — вокзал;- airport — аэропорт;- bus_station — автовокзал;- bus_stop — автобусная остановка;- unknown — станция без типа;- port — порт;- port_point — портпункт;- wharf — пристань;- river_port — речной вокзал;- marine_station — морской вокзал. |
station_type_name |
Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа station_type. |
type_choices |
Объект | Типы расписаний, доступные для станции. Каждый тип описывается в отдельном объекте, который содержит ссылки на мобильную и десктопную версию расписания. Доступные типы: - schedule — вид расписания по умолчанию;- tablo — табло аэропорта;- train — расписание железнодорожного вокзала;- suburban — расписание электричек;- aeroex — расписание аэроэкспрессов. |
title |
Строка | Название станции. |
popular_title |
Строка | Общепринятое название станции. |
short_title |
Строка | Короткое название станции. |
majority |
Строка | Целое число, определяющее относительную важность станции в транспортном сообщении региона, где 1 — высшая важность (например, главный вокзал города). |
transport_type |
Строка | Основной тип транспорта для данной станции. Возможные значения: - plane — самолет;- train — поезд;- suburban — электричка;- bus — автобус;- water — водный транспорт;- helicopter — вертолет. |
lat |
Число | Широта согласно WGS84. |
lng |
Число | Долгота согласно WGS84. |
type |
Строка | Вид найденного пункта. Возможные значения: - station — станция;- settlement — поселение. |
Элементыобъектаtype_choices
| Элемент JSON | Тип | Описание |
total |
Число | Общее количество станций, удовлетворяющих условиям поиска. |
limit |
Число | Ограничение на количество станций, которые Яндекс Расписания возвращают в ответ на запрос. Ограничение можно задать в параметре limit.Значение по умолчанию — 100. |
offset |
Число | Смещение относительно первого результата поиска. Смещение можно задать в параметре offset.Значение по умолчанию — 0. |
<response>
<pagination>
<total>35</total>
<limit>100</limit>
<offset>0</offset>
</pagination>
<station>
<distance>15.8152773714</distance>
<code>s9600215</code>
<title>Внуково</title>
<type_choices>
<tablo>
<desktop_url>https://rasp.yandex.ru/station/9600215/tablo</desktop_url>
<touch_url>https://t.rasp.yandex.ru/station/9600215/tablo</touch_url>
</tablo>
<aeroex>
<desktop_url>https://rasp.yandex.ru/station/9600215/aeroex</desktop_url>
<touch_url>https://t.rasp.yandex.ru/station/9600215/aeroex</touch_url>
</aeroex>
</type_choices>
<station_type>аэропорт</station_type>
<popular_title></popular_title>
<short_title></short_title>
<majority>2</majority>
<transport_type>plane</transport_type>
<lat>55.605817</lat>
<lng>37.288233</lng>
<type>station</type>
</station>
<station>
...
</station>
...
</response>
Описание элементов XML
| Элемент JSON | Тип | Описание |
pagination |
Объект | Информация о постраничном выводе найденных станций. |
station |
Объект | Информация о найденной станции. |
Элементы, вложенные вstations
| Элемент JSON | Тип | Описание |
distance |
Число | Расстояние от станции до точки с указанными в запросе координатами. |
code |
Строка | Код станции в системе кодирования Яндекс Расписаний. |
title |
Строка | Название станции. |
type_choices |
Строка | Типы расписаний, доступные для станции. Каждый тип описывается в отдельном объекте, который содержит ссылки на мобильную и десктопную версию расписания. Доступные типы: - schedule — вид расписания по умолчанию;- tablo — табло аэропорта;- train — расписание железнодорожного вокзала;- suburban — расписание электричек;- aeroex — расписание аэроэкспрессов. |
station_type |
Строка | Тип станции. Возможные значения: - station — станция;- platform — платформа;- stop — остановочный пункт;- checkpoint — блок-пост;- post — пост;- crossing — разъезд;- overtaking_point — обгонный пункт;- train_station — вокзал;- airport — аэропорт;- bus_station — автовокзал;- bus_stop — автобусная остановка;- unknown — станция без типа;- port — порт;- port_point — портпункт;- wharf — пристань;- river_port — речной вокзал;- marine_station — морской вокзал. |
station_type_name |
Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа station_type. |
popular_title |
Строка | Общепринятое название станции. |
short_title |
Строка | Короткое название станции. |
majority |
Строка | Целое число, определяющее относительную важность станции в транспортном сообщении региона, где 1 — высшая важность (например, главный вокзал города). |
transport_type |
Строка | Основной тип транспорта для данной станции. Возможные значения: - plane — самолет;- train — поезд;- suburban — электричка;- bus — автобус;- water — водный транспорт;- helicopter — вертолет. |
lat |
Число | Широта согласно WGS84. |
lng |
Число | Долгота согласно WGS84. |
type |
Строка | Вид найденного пункта. Возможные значения: - station — станция;- settlement — поселение. |
Ключ доступа к API.
Параметр можно не передавать, если ключ доступа указан в заголовке Authorization, например:
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
Широта согласно WGS84.
Долгота согласно WGS84.
Радиус, в котором следует искать ближайший город, в километрах.
Язык возвращаемой информации, в формате <код языка>_<код страны>. Поддерживаемые коды языка описаны стандартом ISO 639, коды стран — стандартом ISO 3166.
По умолчанию ответ возвращается для значения ru_RU.
Поддерживаемые коды языков:
ru— русский;uk— украинский.
Поддерживаемые коды стран:
RU— Россия;UA— Украина.
Формат ответа. Поддерживаемые значения:
json(по умолчанию);xml.
Типы запрашиваемых станций (несколько типов можно перечислить через запятую).
Поддерживаемые значения:
station— станция;platform— платформа;stop— остановочный пункт;checkpoint— блок-пост;post— пост;crossing— разъезд;overtaking_point— обгонный пункт;train_station— вокзал;airport— аэропорт;bus_station— автовокзал;bus_stop— автобусная остановка;unknown— станция без типа;port— порт;port_point— портпункт;wharf— пристань;river_port— речной вокзал;marine_station— морской вокзал.
Типы транспортного средства, для которых нужно искать станции. Несколько типов одновременно можно указать через запятую, например, plane,train,bus.
Поддерживаемые значения:
plane— самолет;train— поезд;suburban— электричка;bus— автобус;sea— морской транспорт;river— речной транспорт;helicopter— вертолет.
Смещение относительно первого результата поиска. Например, если вам не нужны первые 10 результатов поиска, задайте для параметра значение «10».
Значение по умолчанию — 0.
Максимальное количество результатов поиска в ответе.
Значение по умолчанию — 100.
Тип
Строка
Описание
Код пункта прибытия в системе кодирования Яндекс Расписаний.
Тип
Строка
Описание
Вид пункта отправления.
Возможные значения:
station— станция;settlement— поселение.
Тип
Строка
Описание
Название пункта отправления.
Тип
Строка
Описание
Тип отправляющегося транспортного средства.
Возможные значения:
plane— самолет;train— поезд;suburban— электричка;bus— автобус;water— водный транспорт;helicopter— вертолет.
Тип
Объект
Описание
Информация об указанной в запросе станции.
Тип
Строка
Описание
Название нитки, составленное из коротких названий первой и последней станций следования.
Тип
Строка
Описание
Общепринятое название станции.
Тип
Массив
Описание
Информация о постраничном выводе.
Тип
Число
Описание
Общее количество станций, удовлетворяющих условиям поиска.
Тип
Число
Описание
Ограничение на количество станций, которые Яндекс Расписания возвращают в ответ на запрос. Ограничение можно задать в параметре limit.
Значение по умолчанию — 100.
Тип
Число
Описание
Смещение относительно первого результата поиска. Смещение можно задать в параметре offset.
Значение по умолчанию — 0.
Тип
Число
Описание
Расстояние от указанной в запросе точки до полученной в ответе станции.
Тип
Объект
Описание
Типы расписаний, доступные для станции. Каждый тип описывается в отдельном объекте, который содержит ссылки на мобильную и десктопную версию расписания.
Доступные типы:
schedule— вид расписания по умолчанию;tablo— табло аэропорта;train— расписание железнодорожного вокзала;suburban— расписание электричек;aeroex— расписание аэроэкспрессов.
Тип
Строка
Описание
Тип станции. Возможные значения:
station— станция;platform— платформа;stop— остановочный пункт;checkpoint— блок-пост;post— пост;crossing— разъезд;overtaking_point— обгонный пункт;train_station— вокзал;airport— аэропорт;bus_station— автовокзал;bus_stop— автобусная остановка;unknown— станция без типа;port— порт;port_point— портпункт;wharf— пристань;river_port— речной вокзал;marine_station— морской вокзал.
Тип
Строка
Описание
Целое число, определяющее относительную важность станции в транспортном сообщении региона, где 1 — высшая важность (например, главный вокзал города).
Тип
Число
Описание
Широта согласно WGS84.
Тип
Число
Описание
Долгота согласно WGS84.