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

https://search-maps.yandex.ru/v1/
  ? apikey=<string>
  & text=<string>
  & lang=<string>
  & [type=<string>]
  & [ll=<number>, <number>]
  & [spn=<number>, <number>]
  & [bbox=<number>,<number>~<number>,<number>]
  & [rspn=<number>]
  & [results=<integer>]
  & [skip=<integer>]
  & [uri=<string>]

apikey

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

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

Примечание

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

text

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

Текст поискового запроса. Например, название географического объекта, адрес, координаты, название организации, телефон.

Примеры (приведены без URL-кодирования):

text=Дубайский Фонтан

text=25.197091, 55.274259

text=Дубай, Мухаммед Бин Рашид бульвар, 1

text=+971 4 8888888

text=Дубай Молл

lang

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

Предпочитаемый язык ответа. Задается в виде идентификатора локали в виде lang=language_region, где

  • language — двузначный код языка. Указывается в формате ISO 639-1. Задает язык, на котором будут отображаться названия найденных объектов;
  • region — двузначный код страны. Указывается в формате ISO 3166-1. Определяет региональные особенности, например единицу измерения (для обозначения расстояния до найденного объекта).

Примечание

Для регионов RU, UA и TR расстояние показывается в километрах, для US — в милях.

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

  • ru_RU — русский;
  • uk_UA — украинский;
  • be_BY — белорусский;
  • en_RU — американский;
  • en_US — американский английский;
  • tr_TR — турецкий.

Если в значении параметра передается локаль, не входящая в этот список, сервис подбирает язык максимально близкий к заданному.

Пример: lang=uk_UA.

type

Типы возвращаемых результатов. Возможные значения:

  • geo — топонимы;
  • biz — организации;
  • не задано— автоматическое определения типа по тексту запроса.

Пример: type=biz

ll

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

Используется совместно с параметром spn, определяющим размеры области поиска.

Игнорируется при обратном геокодировании.

Пример: ll=55.276394,25.195679&spn=0.552069,0.400552

spn

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

Используется совместно с параметром ll, определяющим центр области поиска.

Игнорируется при обратном геокодировании.

Пример: ll=55.276394,25.195679&spn=0.552069,0.400552

bbox

Альтернативный способ задания области поиска (см. ll+spn).

Границы области поиска задаются в виде географических координат левого нижнего и правого верхнего углов области.

Важно

Cначала задается долгота, а затем широта.

Пример: bbox=25.20, 55.26~25.18, 55.28

Примечание

При одновременном задании bbox и ll+spn параметр bbox является более приоритетным.

rspn

Признак «жесткого» ограничения области поиска.

Если в области поиска (заданной с помощью параметров ll+spn либо bbox) ничего не найдено, сервис пытается найти результаты за ее пределами. Параметр rspn позволяет отключить поиск за пределами заданной области. Возможные значения:

  • 0 — не ограничивать поиск. Используется по умолчанию.
  • 1 — не искать за пределами заданной области.

results

Количество возвращаемых объектов. По умолчанию — 10. Максимальное допустимое значение — 50. Если указан параметр skip, то значение нужно задать явно.

Пример: results=25.

skip

Количество объектов в ответе (начиная с первого), которое необходимо пропустить. Максимальное допустимое значение — 1000. Если указан параметр skip, нужно также задать значение results. Значение skip должно нацело делиться на значение results.

Пример: skip=25.

uri

Дополнительная информация об объекте. Значение параметра возвращается в ответе Геосаджеста. Чтобы использовать его в запросе укажите значение вместо текста и координат.
Предыдущая
Быстрый старт
Следующая
Формат ответа