trip-planner/docs/yandex-api-docs/nearest-settlement.md

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

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

• Синтаксис запроса
• Структура ответа

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

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

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

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

https://api.rasp.yandex-net.ru/v3.0/nearest_settlement/?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.

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

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

Пример ответа в формате 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 — поселение.

<response>
    <distance>4.9813029067</distance>
    <code>c22512</code>
    <title>Пронск</title>
    <lat>54.106677</lat>
    <lng>39.601726</lng>
    <type>settlement</type>
    <popular_title>Пронск</popular_title>
    <short_title>Пронск</short_title>
</response>

Описание элементов XML

Элемент XML	Тип	Описание
distance	Число	Расстояние до найденного города, в километрах.
code	Строка	Код города в системе кодирования Яндекс Расписаний.
title	Строка	Название города.
popular_title	Строка	Общепринятое название города.
short_title	Строка	Краткое название города.
lat	Число	Широта, на которой находится город.
lng	Число	Долгота, на которой находится город.
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 — станция;
• settlement — поселение.

Тип

Число

Описание

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

Тип

Число

Описание

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

Тип

Число

Описание

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

Тип

Строка

Описание

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

Тип

Строка

Описание

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

Тип

Строка

Описание

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

Тип

Строка

Описание

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