Поиск географических объектов

В данном разделе приведены пример запроса и формат ответа сервиса при поиске географических объектов.

Запрос

https://search-maps.yandex.ru/v1/?text=Рай,Россия&type=geo&lang=ru_RU&apikey=<API-ключ>

Формат ответа

Ниже приведен ответ сервиса (для обратного геокодирования формат ответа совпадает).

Внимание. Мы гарантируем поддержку только тех полей, которые описаны в примере ниже. Остальные поля, которые содержатся в ответе, но не описаны в документации, использовать не рекомендуется. В будущем поддержка таких полей не гарантируется.
{   
  "type": "FeatureCollection",
  "properties": {
    "ResponseMetaData": {
      "SearchRequest": {
        "request": "Рай,Россия",
        "results": 10,
        "skip": 0,
        "boundedBy": [
          [
            37.04842675,
            55.43644829
          ],
          [
            38.17590226,
            56.04690124
          ]
        ]
      },
      "SearchResponse": {
        "found": 24,
        "Point": {
          "type": "Point",
          "coordinates": [
            32.01884032,
            54.70408144
          ]
        },
        "boundedBy": [
          [
            32.00759341,
            54.70136583
          ],
          [
            32.03008723,
            54.70679686
          ]
        ],
        "display": "single"
      }
    }
  },
  "features": [
    {
      "type": "Feature",
      "properties": {
        "GeocoderMetaData": {
          "kind": "locality",
          "text": "Россия, Смоленская область, Смоленский район, деревня Рай",
          "precision": "other"
        },
        "description": "Смоленский район, Смоленская область, Россия",
        "name": "деревня Рай",
        "boundedBy": [
          [
            32.007593,
            54.701366
          ],
          [
            32.030087,
            54.706797
          ]
        ]
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          32.024464,
          54.704602
        ]
      }
    }         
  ]
}

Параметры ответа

type *
Всегда имеет значение FeatureCollection. Таким образом обеспечивается соответствие (частичное) с форматом GeoJSON.

Обязательное поле.

properties *
Контейнер метаданных, описывающих запрос и ответ. Обязательное поле.
ResponseMetaData *
Метаданные, описывающие запрос и ответ. Обязательное поле.
SearchRequest *
Метаданные, описывающие запрос. Обязательное поле.
request *
Строка запроса. Обязательное поле.
results
Максимальное количество возвращаемых результатов.
skip
Количество пропускаемых результатов.
boundedBy

Границы области, в которой предположительно находятся искомые объекты.

Задается в виде координат левого верхнего и правого нижнего углов области. Координаты указываются в последовательности «широта, долгота».

Границы области определяются сервисом автоматически.

SearchResponse *

Метаданные, описывающие ответ. Обязательное поле.

found *
Количество найденных объектов. Обязательное поле.
Point *

Данный элемент используется для обеспечения соответствия с форматом GeoJSON. Обязательное поле.

type *
Тип геометрии. Обязательное поле.
coordinates *
Координаты объекта. Обязательное поле.
boundedBy

Границы области показа найденных объектов. Содержит координаты левого нижнего и правого верхнего углов области. Координаты указаны в последовательности «долгота, широта».

display

Рекомендации по отображению результатов поиска. Возможные значения:

  • "single" — рекомендуется отображать первый найденный объект;
  • "multiple" — рекомендуется отображать все найденные объекты.
features *
Контейнер результатов поиска. Обязательное поле.
type *
Всегда имеет значение Feature. Таким образом обеспечивается соответствие (частичное) с форматом GeoJSON. Обязательное поле.
properties *
Метаданные, описывающие найденный объект. Обязательное поле.
GeocoderMetaData *
Подробная информация о найденном объекте. Обязательное поле.
kind *

Вид топонима. Список возможных значений:

  • "house" — дом;
  • "street" — улица;
  • "metro" — станция метро;
  • "district" — район города;
  • "locality" — населенный пункт (город/поселок/деревня/село/...).

Обязательное поле.

text *
Полный адрес объекта. Обязательное поле.
precision *
Точность соответствия между номером найденного дома и номером дома из запроса (см. подробнее). Обязательное поле.
description
Текст, который рекомендуется указывать в качестве подзаголовка при отображении найденного объекта.
name
Текст, который рекомендуется указывать в качестве заголовка при отображении найденного объекта.
boundedBy
Границы области, в которую входит организация. Содержит координаты левого нижнего и правого верхнего углов области. Координаты указаны в последовательности «долгота, широта».
geometry *
Описание геометрии найденного объекта. Обязательное поле.
type *
Тип геометрии. Обязательное поле.
coordinates *
Координаты объекта. Обязательное поле.

Обязательный параметр