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

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

https://suggest-maps.yandex.ru/v1/suggest?apikey=YOUR_API_KEY&text=бурдж&print_address=1&attrs=uri

В этом случае ответ будет выглядеть следующим образом:

{
  "results": [
    {
      "title": {
        "text": "Бурдж Халифа, Дубай",
        "hl": [{
          "begin": 0,
          "end": 10
        },
        {
          "begin": 18,
          "end": 20
        }]
      },
      "subtitle": {
        "text": "Дубай"
      },
      "tags": [
        "house"
      ],
      "distance": {
        "text": "7141.91 км",
        "value": 7141908.95
      },
      "address": {
        "formatted_address": "Бурдж Халифа, Забиль, эмират Дубай",
        "component": [
          {
            "name": "Объединённые Арабские Эмираты",
            "kind": [
              "COUNTRY"
            ]
          },
          {
            "name": "Забиль",
            "kind": [
              "PROVINCE"
            ]
          },
          {
            "name": "эмират Дубай",
            "kind": [
              "PROVINCE"
            ]
          },
          {
            "name": "Дубай",
            "kind": [
              "LOCALITY"
            ]
          },
          {
            "name": "Забиль",
            "kind": [
              "STREET"
            ]
          },
          {
            "name": "1",
            "kind": [
              "HOUSE"
            ]
          }
        ]
      },
      "uri": "ymapsbm1://geo?data=Cgg1MzA2MzU1OBIy0JzQvtGB0LrQvtCy0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwsINCc0YvRgtC40YnQuCA,"
    }
  ]
}

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

results

Результаты запроса в виде массива найденных объектов. Если ничего не найдено, параметр может отсутствовать.

title

Название объекта.

text

Название объекта.

hl

Подсвечивает в интерфейсе фрагмент строки text, совпадающий с запросом пользователя.

begin

Начало диапазона индексов символов строки text для подсвечивания.

end

Окончание диапазона индексов символов строки text для подсвечивания.

Индексы задаются как номера 16-битных code unit'ов строки, записанной в кодировке UTF-16.

subtitle

Дополнительное название объекта.

text

Название объекта.

hl

Подсвечивает в интерфейсе фрагмент строки text, совпадающий с запросом пользователя.

tags

Тип найденного объекта:

• для организации из справочника используется тег business

  Дополнительные теги по роду деятельности организации

  • airport terminal
  • airports
  • animation
  • attraction
  • auto
  • baggage room
  • banks
  • bars
  • beach
  • bench
  • bike
  • bike rent
  • boat station
  • buddhism
  • bus station
  • bus stop
  • cableway
  • cafe
  • car park
  • catholic church
  • catholic church
  • cemetery
  • childrens playground
  • christmastree
  • cinemas
  • clothes shop
  • college
  • concert hall
  • confectionary
  • currency exchange
  • dance pavilion
  • dental
  • drugstores
  • dry cleaning
  • emergency point tr
  • fallback fun
  • fallback outdoor
  • fallback services
  • fast food
  • festival
  • fire station
  • fireworks launching
  • fitness
  • flower shop
  • forest
  • fountain
  • furniture store
  • garden
  • gasstation
  • government
  • hairdressers
  • haulier
  • helicopter
  • highspeed tram stop
  • hotels
  • hypermarket
  • industrial enterprise
  • information
  • information desk
  • landmark
  • laundry
  • malls
  • medicine
  • memorable event
  • metro
  • monument
  • mosque
  • mountain
  • office
  • office service
  • orthodox church
  • park
  • pet playground
  • petshop
  • photo
  • picnic
  • pier
  • playground
  • police
  • police post
  • port
  • post office
  • protestant church
  • racing
  • railway station
  • railway terminal
  • restaurants
  • rezervation
  • sanatorium
  • scene
  • security post
  • skating rink
  • software
  • spa
  • sportcenter
  • spring
  • stadium
  • stenograffia
  • supermarket
  • sushi
  • swimming pool
  • synagogue
  • tailor
  • taxi
  • theatre
  • tire fitting
  • trade point
  • tram stop
  • trash
  • travel agency
  • tribune
  • viewpoint
  • waterfall
  • waterpark
  • wc
  • yandex shop
  • zoo

• для географического объекта используются разные теги

  Теги для топонима

  • street
  • metro
  • district
  • locality
  • area
  • province
  • country
  • hydro
  • railway
  • station
  • route
  • vegetation
  • airport
  • other
  • house

distance

Расстояние до объекта в метрах.

• Расчитывается от координаты пользователя, если она указана в запросе;
• Или от центра окна поиска, если координаты пользователя не заданы.

text

Локализованное представление.

value

Расстояние в метрах.

address

Адрес найденного объекта.

formatted_address

Адрес объекта.

component

Компоненты адреса.

name

Название компонента адреса.

kind

Тип компонента адреса. Может вернуться два компонента с одинаковыми значениями параметра kind, но с разными значениями name.

Возможные значения

• country — страна
• region — регион
• province — область;
• area — район обласи, городской совет
• locality — населенный пункт
• district — район, микрорайон, квартал города, посёлок
• street — улица
• house — дом
• hydro — река, озеро, ручей, водохранилище и т.п.
• station — остановка
• metro_station — станция метро
• railway_station — железнодорожная станция
• route — линия метро, шоссе, ж.д. линия
• vegetation — лес, парк, сад и т.п.
• airport — аэропорт
• other — прочее
• entrance — вход
• level — этаж
• apartment — квартира
• unknown — ничего из перечисленного

uri

Дополнительная информация об объекте, которую можно использовать в запросе к API Геокодера — для этого укажите значение параметра uri вместо текста и координат.

Сообщения об ошибкахСообщения об ошибках