Ближайший город

Запрос позволяет получить информацию о ближайшем к указанной точке городе. Точка определяется географическими координатами (широтой и долготой) согласно WGS84. Поиск можно ограничить определенным радиусом (по умолчанию — 10 километров, но не больше 50).

Примечание.

Запрос следует отправлять по протоколу HTTPS.

  1. Синтаксис запроса
  2. Структура ответа

Синтаксис запроса

https://api.rasp.yandex.net/v3.0/nearest_settlement/ ?
  apikey=<ключ> 
& lat=<широта>
& lng=<долгота>
& [distance=<радиус охвата>]
& [lang=<язык>]
& [format=<формат>]

Пример запроса:

https://api.rasp.yandex.net/v3.0/nearest_settlement/?apikey={ключ}&format=json&lat=50.440046&lng=40.4882367&distance=50&lang=ru_RU

Входные параметры:

Параметр Описание
Обязательные параметры
apikey

Ключ доступа к API.

Параметр можно не передавать, если ключ доступа указан в заголовке Authorization, например:

Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
lat

Широта согласно WGS84.

lng

Долгота согласно WGS84.

Необязательные параметры
distance

Радиус, в котором следует искать ближайший город, в километрах.

lang

Язык возвращаемой информации, в формате <код языка>_<код страны>. Поддерживаемые коды языка описаны стандартом ISO 639, коды стран — стандартом ISO 3166.

По умолчанию ответ возвращается для значения ru_RU.

Поддерживаемые коды языков:

  • ru — русский;

  • uk — украинский.

Поддерживаемые коды стран:

  • RU — Россия;

  • UA — Украина.

format

Формат ответа. Поддерживаемые значения:

  • json (по умолчанию);

  • xml.

Структура ответа

Ответ представляет собой информацию о ближайшем к указанной точке городе, находящемся внутри указанного радиуса поиска.

{
  "distance": 4.981302906703597,
  "code": "c22512",
  "title": "Пронск",
  "popular_title": "Пронск",
  "short_title": "Пронск",
  "lat": 54.106677,
  "lng": 39.601726,
  "type": "settlement"
}
Описание элементов JSON
Элемент JSON Тип Описание
distance Число

Расстояние до найденного города, в километрах.

code Строка

Код города в системе кодирования Яндекс.Расписаний.

title Строка

Название города.

popular_title Строка

Общепринятое название города.

short_title Строка

Краткое название города.

lat Число

Широта, на которой находится город.

lng Число

Долгота, на которой находится город.

type Строка

Тип транспортного пункта:

  • station — станция;

  • settlement — поселение.