Поиск по организациям

API возвращает список организаций, наиболее подходящих запросу. Например, по запросу «аптеки Москвы» в списке результатов отобразятся не все аптеки города, а наиболее подходящие запросу с точки зрения API.

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

Запрос

https://search-maps.yandex.ru/v1/?text=Автосервис, Москва, 2 Вязовский проезд 4а&type=biz&lang=ru_RU&results=1&apikey=<API-ключ>

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

Внимание. Мы гарантируем поддержку только тех полей, которые описаны в примере ниже. Остальные поля, которые содержатся в ответе, но не описаны в документации, использовать не рекомендуется. В будущем поддержка таких полей не гарантируется.
{
  "type": "FeatureCollection",
  "properties": {
    "ResponseMetaData": {
      "SearchRequest": {
        "request": "Автосервис, Москва, 2 Вязовский проезд 4а",
        "results": 1,
        "skip": 0,
        "boundedBy": [
          [
            37.04842675, 
            55.43644829
          ],
          [
            38.17590226,
            56.04690124
          ]
        ]
      },
      "SearchResponse": {
        "found": 36,
        "boundedBy": [
          [
            37.76257841,
            55.71649343
          ],
          [
            37.76644117, 
            55.72008348 
          ]
        ],
        "display": "multiple"
      }
    }
  },
  "features": [
    {
      "type": "Feature",
      "properties": {
        "CompanyMetaData": {
          "id": "1186386819",
          "name": "Автосервис 24 часа",
          "address": "Россия, Москва, 2-й Вязовский проезд, 4А, стр. 5",
          "url": "http://автосервис-ювао.рф/",
          "Categories": [
            {
              "class": "auto repair",
              "name": "Автосервис, автотехцентр"
            }, {
              "class": "tire fitting",
              "name": "Шиномонтаж"
            }, {
              "class": "car wash",
              "name": "Автомойка"
            }
          ],
          "Phones": [
            {
              "type": "phone",
              "formatted": "+7 (495) 778-44-45"
            }, {
              "type": "phone",
              "formatted": "+7 (499) 372-00-60",
            }
          ],
          "Hours": {
            "Availabilities": [
              {
                "Everyday": true,
                "TwentyFourHours": true
              }
            ],
            "text": "ежедневно, круглосуточно",
          }
        },  
        "description": "Россия, Москва, 2-й Вязовский проезд, 4А, стр. 5",
        "name": "Автосервис 24 часа",
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          37.764661,
          55.719081
        ]
      }
    }
  ]
}  
type *
Всегда имеет значение FeatureCollection. Таким образом обеспечивается соответствие (частичное) с форматом GeoJSON.

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

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

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

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

SearchResponse *

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

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

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

display

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

  • «single» — рекомендуется отображать только первый найденный объект;
  • «multiple» — рекомендуется отображать все найденные объекты.
features *
Контейнер результатов поиска. Обязательное поле.
type *

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

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

properties *
Информация о найденном объекте. Обязательное поле.
CompanyMetaData

Содержит сведения об отдельной организации: адрес, контактную информацию, режим работы, вид деятельности и др.

id *

Идентификатор организации. Обязательное поле.

name *
Название организации. Обязательное поле.
address

Адрес организации.

url
Сайт организации.
Categories
Список категорий, в которые входит организация (например, салон красоты, отель или магазин).
class
Класс категории.
name *
Название категории. Обязательное поле.
Phones
Список телефонных номеров организации и другая контактная информация.
type
Тип контактной информации (например, телефон или факс).
formatted *
Полный номер телефона (или факса) с кодом страны и кодом города. Обязательное поле.
Hours
Режим работы организации.
Availabilities
Описание режима. Может содержать поля:
  • Weekdays|Weekend|Everyday|Sunday|Monday.. — рабочие дни;
  • TwentyFourHours|Intervals — часы работы.
Everyday

Организация работает каждый день.

TwentyFourHours
Организация работает круглосуточно.
text *
Описание режима работы в виде произвольного текста. Обязательное поле.
description
Текст, который рекомендуется указывать в качестве подзаголовка при отображении найденной организации.
name

Текст, который рекомендуется указывать в качестве заголовка при отображении найденной организации.

geometry *

Описание геометрии найденного объекта. Обязательное поле.

type *
Тип геометрии. Обязательное поле.
coordinates *

Координаты организации в последовательности «долгота, широта». Обязательное поле.

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