Формат запроса

https://suggest-maps.yandex.ru/v1/suggest
  ? apikey=<string>
  & text=<string>
  & [sessiontoken=<string>]
  & [lang=<string>]
  & [results=<string>]
  & [highlight=<string>]
  & [ll=<string>]
  & [spn=<string>]
  & [bbox=<string>]
  & [ull=<string>]
  & [strict_bounds=<string>]
  & [types=<string>]
  & [print_address=<string>]
  & [org_address_kind=<string>]
  & [attrs=<string>]

apikey

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

Ключ, полученный в Кабинете Разработчика.

Примечание

Ключ будет активирован в течение 15 минут после получения.

text

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

Пользовательский ввод (префикс). Непустая строка в кодировке UTF-8.

sessiontoken

Случайная уникальная строка, которая идентифицирует сеанс. Нужна для правильной тарификации запросов.

В течение одних суток можно делать несколько запросов в АПИ, подписываясь одним и тем же sessiontoken. Такие запросы будут тарифицироваться как один сеанс.

lang

Язык, на котором будут отображаться названия географических объектов. Например lang=en — английский.
Указывается в формате ISO 639-1.

results

Максимальное количество подсказок. Целое число до 10. По умолчанию применяется значение results=7.

highlight

По умолчанию сервис осуществляет подсветку совпадений в результатах и возвращает набор диапазонов индексов, которые можно выделить в интерфейсе. Значение highlight=0 отключает подсветку.

ll

Координаты центра окна поиска, если оно задается в виде прямоугольника с координатами центра и размерами.

Используется формат {lon},{lat}, где:

  • {lon} — долгота в диапазоне от −180° до +180°;
  • {lat} — широта в диапазоне от −90° до +90°.

spn

Ширина и высота окна поиска в градусах, если оно задано в виде прямоугольника с координатами центра и размерами. Значения записываются через запятую без пробела.

Если параметр не задан, значение по умолчанию spn=0.1,0.1.

bbox

Координаты левого нижнего и правого верхнего угла, когда окно поиска задано при помощи координат противоположных углов.

ull

Координаты пользователя, определённые по GPS (геолокация). Используется при расчете расстояний.

Передается в дополнении к окну. Если параметр не указан, по умолчанию для расчетов будет взят центр окна.

strict_bounds

Используется в значении strict_bounds=1, чтобы строго ограничить выдачу и оставлять только объекты, которые попадают в окно. Окно не накладывает строгого ограничения на результаты поиска и носит рекомендательный характер, помогая отобрать наиболее релевантные подсказки.

types

Тип объекта в ответе. Поддерживаемые типы:

  • biz — все организации;
  • geo — все географические объекты;
  • street — улица;
  • metro — станция метро;
  • district — район, микрорайон, квартал города, посёлок;
  • locality — село, аул, город, жилой комплекс, садовое товарищество;
  • area — район области, городской совет;
  • province — область, административный округ, город федерального значения;
  • country — страна;
  • house — дом, здание, строение;
  • entrance — подъезд.

Типы перечисляются через запятую, без пробелов. Фильтрация работает через оператор «или», в случае одновременного использования больший тип поглощает меньшие. Например, ...&types=street,geo,station&... будет означать ..&types=geo&....

Возвращает покомпонентный адрес в ответе. Для этого укажите значение print_address=1.

org_address_kind

Возвращает список организаций только с адресом до номера дома. Для этого используйте значение org_address_kind=house. Можно использовать совместно с types=biz или любым другим типом объета, предполагающим получение адреса в ответе, или отдельно.

attrs

Используется в значении attrs=uri. Возвращает в ответе параметр uri, значение которого можно использовать в запросе API Геокодера для получения дополнительных сведений об объекте.
Предыдущая
Быстрый старт
Следующая
Формат ответа