Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Поля с пометкой `требуется дополнительное разрешение у ключа API` будут присутствовать в выдаче только при выставленных разрешениях на это поле у ключа. По умолчанию ключ не имеет никакие из указанных дополнительных разрешений. Список полей с информацией о геометрии и адресе места: <ul> <li>`items.point` — координаты объекта, заданные в системе координат WGS84 в формате lon, lat;</li> <li>`items.address` — адрес, по которому располагается объект;</li> <li>`items.adm_div` — принадлежность к административной территории;</li> <li>`items.full_address_name` — адрес объекта с указанием города;</li> <li>`items.geometry.centroid` — визуальный центр геометрии объекта;</li> <li>`items.geometry.hover` — геометрия области, используемой для определения попадания курсора в зону объекта;</li> <li>`items.geometry.selection` — геометрия для выделения объекта;</li> </ul> Список полей с дополнительной информацией о месте: <ul> <li>`items.rubrics` — категории компании;</li> <li>`items.org` — организация, к которой относится филиал;</li> <li>`items.contact_groups` — контакты компании (требуется дополнительное разрешение у ключа API);</li> <li>`items.schedule` — расписание работы компании;</li> <li>`items.access_comment` — локализованное название для типа доступа;</li> <li>`items.access` — тип доступа для парковки;</li> <li>`items.capacity` — вместимость парковки;</li> <li>`items.description` — описание геообъекта;</li> <li>`items.external_content` — дополнительные данные компании, такие как буклеты и фотографии;</li> <li>`items.flags` — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;</li> <li>`items.floors` — количество этажей (требуется дополнительное разрешение у ключа API);</li> <li>`items.floor_plans` — планы этажей (требуется дополнительное разрешение у ключа API);</li> <li>`items.is_paid` — является ли парковка платной;</li> <li>`items.for_trucks` — парковка для грузовиков;</li> <li>`items.paving_type` — тип покрытия парковки;</li> <li>`items.is_incentive` — является ли парковка перехватывающей;</li> <li>`items.purpose` — назначение парковки;</li> <li>`items.level_count` — количество уровней парковки;</li> <li>`items.links` — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);</li> <li>`items.links.database_entrances.apartments_info` — информация о квартирах в доме (требуется дополнительное разрешение у ключа API);</li> <li>`items.name_ex` — составные части наименования объекта;</li> <li>`items.reviews` — статистика по отзывам об объекте;</li> <li>`items.statistics` — cводная информация о геообъекте;</li> <li>`items.employees_org_count` — численность сотрудников организации (требуется дополнительное разрешение у ключа API);</li> <li>`items.itin` — индивидуальный номер налогоплательщика (требуется дополнительное разрешение у ключа API);</li> <li>`items.trade_license` — лицензия филиала (требуется дополнительное разрешение у ключа API);</li> <li>`items.fias_code` — код ФИАС улиц и административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.address.components.fias_code` — код ФИАС зданий (требуется дополнительное разрешение у ключа API);</li> <li>`items.fns_code` — код ФНС административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.okato` — код ОКАТО улиц и административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.address.components.okato` — код ОКАТО зданий (требуется дополнительное разрешение у ключа API);</li> <li>`items.oktmo` — код ОКТМО улиц и административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.address.components.oktmo` — код ОКТМО зданий (требуется дополнительное разрешение у ключа API);</li> </ul> Список служебных полей: <ul> <li>`context_rubrics` — массив контекстных категорий;</li> <li>`dym` — блок «Возможно, вы имели ввиду»;</li> <li>`filters` — фильтры для дополнительного поиска;</li> <li>`hash` — базовый хеш;</li> <li>`items.ads.options` — рекламные опции;</li> <li>`items.attribute_groups` — дополнительные атрибуты компании;</li> <li>`items.context` — динамическая информация;</li> <li>`items.dates.deleted_at` — дата удаления организации из базы в формате ISO 8601;</li> <li>`items.dates.updated_at` — дата последнего изменения информации об организации в формате ISO 8601;</li> <li>`items.dates` — время внесения информации о компании в БД;</li> <li>`items.geometry.style` — идентификатор стиля для отображения;</li> <li>`items.group` — связанные в объединённую карточку объекты;</li> <li>`items.metarubrics` — метарубрики для выдачи организаций в гибридном объекте;</li> <li>`items.delivery` — есть доставка;</li> <li>`items.has_goods` — загружен список товаров фирмы;</li> <li>`items.has_pinned_goods` — у фирмы включен блок «Закрепленные товары»;</li> <li>`items.has_realty` — есть недвижимость на продаже;</li> <li>`items.has_audiogid` — есть аудиогид у объекта;</li> <li>`items.has_discount` — есть скидки;</li> <li>`items.has_exchange` — признак наличия курсов валют у филиала;</li> <li>`items.is_main_in_group` — признак того, что это главный объект в группе объектов гибрида;</li> <li>`items.city_alias` — алиас города, в котором находится объект;</li> <li>`items.detailed_subtype` — детализированный тип административно-территориальной единицы;</li> <li>`items.alias` — транслитерированное название объекта;</li> <li>`items.caption` — название объекта;</li> <li>`items.is_promoted` — фирма участвует в промо-акции Чека;</li> <li>`items.routes` — маршруты транспорта, проходящие через станцию или остановку;</li> <li>`items.directions` — направления маршрута;</li> <li>`items.barrier` — тип заграждения;</li> <li>`items.is_routing_available` — флаг, возможен ли проезд до объекта;</li> <li>`items.entrance_display_name` — показать номер входа на станцию метро, если объект является входом (station_entrance);</li> <li>`items.locale` — текущая локаль для региона;</li> <li>`items.reg_bc_url` — URL для регистрации бизнес-коннекшна просмотра профиля;</li> <li>`items.region_id` — уникальный идентификатор проекта;</li> <li>`items.segment_id` — уникальный идентификатор сегмента;</li> <li>`items.stat` — данные для формирования сообщений статистики;</li> <li>`items.stop_factors` — набор блокирующих атрибутов, соответствующих запросу;</li> <li>`items.has_apartments_info` — признак наличия информации о квартирах в здании;</li> <li>`items.timezone` — часовой пояс в формате POSIX;</li> <li>`items.timezone_offset` — смещение таймзоны в минутах относительно UTC0;</li> <li>`items.comment` — комментарий ко входу;</li> <li>`items.station_id` — уникальный идентификатор остановки, к которой относится остановочная платформа;</li> <li>`items.platforms` — остановочные платформы остановки;</li> <li>`items.sources` — идентификатор источника данных об объекте;</li> <li>`items.structure_info.material` — данные о материале здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.apartments_count` — данные о количестве квартир в здании (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.porch_count` — данные о количестве подъездов в здании (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.floor_type` — тип перекрытий в здании (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.gas_type` — тип газоснабжения здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.year_of_construction` — год постройки здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.elevators_count` — количество лифтов в здании (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.is_in_emergency_state` — факт признания дома аварийным (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.project_type` — серия/проект постройки здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.chs_name` — название ОКН (объекта культурного наследия), требуется дополнительное разрешение у ключа API;</li> <li>`items.structure_info.chs_category` — категория ОКН (требуется дополнительное разрешение у ключа API);</li> <li>`items.route_logo` — иконка метро;</li> <li>`items.order_with_cart` — свойства заказа у организации без доставки, но с корзиной;</li> <li>`items.is_deleted` — признак удаленного объекта;</li> <li>`items.search_attributes` — параметры результата поиска для найденного объекта. Каждое поле внутри `items.search_attributes` нужно запрашивать отдельно через точку, например, `items.search_attributes.segment_id`. Список доступных полей внутри объекта `items.search_attributes` можно посмотреть в схеме ответа для любого объекта внутри items;</li> <li>`items.congestion` — загруженность филиала;</li> <li>`items.poi_category` — категория POI;</li> <li>`items.has_dynamic_congestion` — признак наличия онлайн значения текущей загруженности филиала;</li> <li>`items.temporary_unavailable_atm_services` — признак наличия неработающих услуг у банкомата или терминала;</li> <li>`items.marker_alt` — относительная высота размещения маркера;</li> <li>`items.floor_id` — идентификатор этажа;</li> <li>`items.purpose_code` — код назначения здания;</li> <li>`request_type` — тип поискового запроса;</li> <li>`search_attributes` — информация о произведённом поиске;</li> <li>`widgets` — виджеты;</li> <li>`items.name_back` — для дорожного знака локализованное название в обратном направлении при наличии;</li> <li>`items.value_back` — для дорожного знака номер километра в обратном направлении;</li> <li>`items.ev_charging_station ` — аттрибуты электрозаправок;</li> <li>`items.ski_lift ` — информация о горнолыжном подъемнике;</li> <li>`items.has_ads_model` — признак наличия рекламной 3D модели в здании;</li> </ul>

Пример нескольких типов

Пример единичного типа

fields

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Поля с пометкой `требуется дополнительное разрешение у ключа API` будут присутствовать в выдаче только при выставленных разрешениях на это поле у ключа. По умолчанию ключ не имеет никакие из указанных дополнительных разрешений. Список полей с информацией о геометрии и адресе места: <ul> <li>`items.point` — координаты объекта, заданные в системе координат WGS84 в формате lon, lat;</li> <li>`items.address` — адрес, по которому располагается объект;</li> <li>`items.adm_div` — принадлежность к административной территории;</li> <li>`items.full_address_name` — адрес объекта с указанием города;</li> <li>`items.geometry.centroid` — визуальный центр геометрии объекта;</li> <li>`items.geometry.hover` — геометрия области, используемой для определения попадания курсора в зону объекта;</li> <li>`items.geometry.selection` — геометрия для выделения объекта;</li> </ul> Список полей с дополнительной информацией о месте: <ul> <li>`items.rubrics` — категории компании;</li> <li>`items.org` — организация, к которой относится филиал;</li> <li>`items.contact_groups` — контакты компании (требуется дополнительное разрешение у ключа API);</li> <li>`items.schedule` — расписание работы компании;</li> <li>`items.access_comment` — локализованное название для типа доступа;</li> <li>`items.access` — тип доступа для парковки;</li> <li>`items.capacity` — вместимость парковки;</li> <li>`items.description` — описание геообъекта;</li> <li>`items.external_content` — дополнительные данные компании, такие как буклеты и фотографии;</li> <li>`items.flags` — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т.д. Список доступных признаков можно посмотреть в схеме ответа внутри items;</li> <li>`items.floors` — количество этажей (требуется дополнительное разрешение у ключа API);</li> <li>`items.floor_plans` — планы этажей (требуется дополнительное разрешение у ключа API);</li> <li>`items.is_paid` — является ли парковка платной;</li> <li>`items.for_trucks` — парковка для грузовиков;</li> <li>`items.paving_type` — тип покрытия парковки;</li> <li>`items.is_incentive` — является ли парковка перехватывающей;</li> <li>`items.purpose` — назначение парковки;</li> <li>`items.level_count` — количество уровней парковки;</li> <li>`items.links` — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое);</li> <li>`items.links.database_entrances.apartments_info` — информация о квартирах в доме (требуется дополнительное разрешение у ключа API);</li> <li>`items.name_ex` — составные части наименования объекта;</li> <li>`items.reviews` — статистика по отзывам об объекте;</li> <li>`items.statistics` — cводная информация о геообъекте;</li> <li>`items.employees_org_count` — численность сотрудников организации (требуется дополнительное разрешение у ключа API);</li> <li>`items.itin` — индивидуальный номер налогоплательщика (требуется дополнительное разрешение у ключа API);</li> <li>`items.trade_license` — лицензия филиала (требуется дополнительное разрешение у ключа API);</li> <li>`items.fias_code` — код ФИАС улиц и административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.address.components.fias_code` — код ФИАС зданий (требуется дополнительное разрешение у ключа API);</li> <li>`items.fns_code` — код ФНС административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.okato` — код ОКАТО улиц и административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.address.components.okato` — код ОКАТО зданий (требуется дополнительное разрешение у ключа API);</li> <li>`items.oktmo` — код ОКТМО улиц и административных территорий (требуется дополнительное разрешение у ключа API);</li> <li>`items.address.components.oktmo` — код ОКТМО зданий (требуется дополнительное разрешение у ключа API);</li> </ul> Список служебных полей: <ul> <li>`hash` — базовый хеш;</li> <li>`items.ads.options` — рекламные опции;</li> <li>`items.attribute_groups` — дополнительные атрибуты компании;</li> <li>`items.context` — динамическая информация;</li> <li>`items.dates.deleted_at` — дата удаления организации из базы в формате ISO 8601;</li> <li>`items.dates.updated_at` — дата последнего изменения информации об организации в формате ISO 8601;</li> <li>`items.dates` — время внесения информации о компании в БД;</li> <li>`items.geometry.style` — идентификатор стиля для отображения;</li> <li>`items.group` — связанные в объединённую карточку объекты;</li> <li>`items.metarubrics` — метарубрики для выдачи организаций в гибридном объекте;</li> <li>`items.delivery` — есть доставка;</li> <li>`items.has_goods` — загружен список товаров фирмы;</li> <li>`items.has_pinned_goods` — у фирмы включен блок «Закрепленные товары»;</li> <li>`items.has_realty` — есть недвижимость на продаже;</li> <li>`items.has_audiogid` — есть аудиогид у объекта;</li> <li>`items.has_discount` — есть скидки;</li> <li>`items.has_exchange` — признак наличия курсов валют у филиала;</li> <li>`items.is_main_in_group` — признак того, что это главный объект в группе объектов гибрида;</li> <li>`items.city_alias` — алиас города, в котором находится объект;</li> <li>`items.detailed_subtype` — детализированный тип административно-территориальной единицы;</li> <li>`items.alias` — транслитерированное название объекта;</li> <li>`items.caption` — название объекта;</li> <li>`items.is_promoted` — фирма участвует в промо-акции Чека;</li> <li>`items.routes` — маршруты транспорта, проходящие через станцию или остановку;</li> <li>`items.directions` — направления маршрута;</li> <li>`items.barrier` — тип заграждения;</li> <li>`items.is_routing_available` — флаг, возможен ли проезд до объекта;</li> <li>`items.entrance_display_name` — показать номер входа на станцию метро, если объект является входом (station_entrance);</li> <li>`items.locale` — текущая локаль для региона;</li> <li>`items.reg_bc_url` — URL для регистрации бизнес-коннекшна просмотра профиля;</li> <li>`items.region_id` — уникальный идентификатор проекта;</li> <li>`items.segment_id` — уникальный идентификатор сегмента;</li> <li>`items.stat` — данные для формирования сообщений статистики;</li> <li>`items.stop_factors` — набор блокирующих атрибутов, соответствующих запросу;</li> <li>`items.has_apartments_info` — признак наличия информации о квартирах в здании;</li> <li>`items.timezone` — часовой пояс в формате POSIX;</li> <li>`items.timezone_offset` — смещение таймзоны в минутах относительно UTC0;</li> <li>`items.comment` — комментарий ко входу;</li> <li>`items.station_id` — уникальный идентификатор остановки, к которой относится остановочная платформа;</li> <li>`items.platforms` — остановочные платформы остановки;</li> <li>`items.sources` — идентификатор источника данных об объекте;</li> <li>`items.structure_info.material` — данные о материале здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.apartments_count` — данные о количестве квартир (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.porch_count` — данные о количестве подъездов (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.floor_type` — тип перекрытий в здании (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.gas_type` — тип газоснабжения здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.year_of_construction` — год постройки здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.elevators_count` — количество лифтов в здании (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.is_in_emergency_state` — факт признания дома аварийным (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.project_type` — серия/проект постройки здания (требуется дополнительное разрешение у ключа API);</li> <li>`items.structure_info.chs_name` — название ОКН (объекта культурного наследия), требуется дополнительное разрешение у ключа API;</li> <li>`items.structure_info.chs_category` — категория ОКН (требуется дополнительное разрешение у ключа API);</li> <li>`items.route_logo` — иконка метро;</li> <li>`items.order_with_cart` — свойства заказа у организации без доставки, но с корзиной;</li> <li>`items.is_deleted` — признак удаленного объекта.</li> <li>`items.congestion` — загруженность филиала;</li> <li>`items.poi_category` — категория POI;</li> <li>`items.has_dynamic_congestion` — признак наличия онлайн значения текущей загруженности филиала;</li> <li>`items.temporary_unavailable_atm_services` — признак наличия неработающих услуг у банкомата или терминала;</li> <li>`items.marker_alt` — относительная высота размещения маркера;</li> <li>`items.floor_id` — идентификатор этажа;</li> <li>`items.purpose_code` — код назначения здания;</li> <li>`items.name_back` — для дорожного знака локализованное название в обратном направлении при наличии;</li> <li>`items.value_back` — для дорожного знака номер километра в обратном направлении;</li> <li>`items.ev_charging_station ` — аттрибуты электрозаправок;</li> <li>`items.ski_lift ` — информация о горнолыжном подъемнике;</li> <li>`items.has_ads_model` — признак наличия рекламной 3D модели в здании;</li> </ul>

Фильтр по наличию индивидуального номера налогоплательщика. Принимает значения: true или false.

has_itin

Фильтр по наличию фотографий. Принимает значения: true или false.

has_photos

Фильтр по наличию рейтинга на flamp.ru. Принимает значения: true или false.

has_rating

Фильтр по наличию отзывов на flamp.ru. Принимает значения: true или false.

has_reviews

Фильтр по наличию сайта. Принимает значения: true или false.

has_site

Фильтр по наличию торговой лицензии. Принимает значения true или false.

has_trade_license

Фильтрует компании у которых дата открытия позже чем переданный параметр. Принимает значения в формате YYYY-MM-DD.

Позже чем 3 сентября 2007 года

opened_after_date

Фильтр по идентификатору организации, к которой относится компания.

org_id

Идентификатор категории. Необходимо передать параметр `region_id`. Также можно передавать список идентификаторов категорий через запятую. В этом случае все категории должны быть из одного региона.

Пример нескольких записей

Пример единичной записи

rubric_id

Время работы организации. Формат: [day],[time] или now (текущий день и время). Примеры: <ul> <li>Понедельник, 17:00 — `mon,17:00`</li> <li>Четверг, 9:00 — `thu,09:00`</li> <li>Сегодня, 9:00 — `today,09:00`</li> <li>Пятница, весь день — `fri,alltime`</li> <li>Сейчас — `now`</li> </ul>

Вторник, круглосуточно

work_time

IP-адрес. Допустимы IPv4- и IPv6-нотации.


Уникальный ключ пользователя API.


Координаты пользователя в формате `lon, lat`.

location

Идентификаторы зданий, разделённые запятыми. Используется для фильтрации объектов в здании. Максимальное количество — 50.

Пример нескольких идентификаторов

Пример единичного идентификатора

building_id

Идентификаторы городов, разделённые запятыми. Используется для фильтрации объектов по городу. Максимальное количество — 50.

city_id

Идентификаторы районов, разделённые запятыми. Используется для фильтрации объектов по району. Максимальное количество — 50.

district_id

Широта точки — центра области поиска. Обязательно использование совместно с параметром `lon`. Допустимый интервал значений: от -90 до 90. Может использоваться совместно с параметром `radius` для фильтрации результатов в окружности.

Долгота точки — центра области поиска. Обязательно использование совместно с параметром `lat`. Допустимый интервал значений: от -180 до 180. Может использоваться совместно с параметром `radius` для фильтрации результатов в окружности.

Центр области поиска (координаты точки в формате `lon, lat`). Используется для фильтрации результатов в окружности. Параметр конфликтует с параметрами `polygon`, `point1`, `point2`.

point

Координаты левой верхней вершины прямоугольной области в формате `lon, lat`, ограничивающей результаты выборки. Используется для фильтрации результатов в прямоугольной области. Максимальное расстояние между точками `point1` и `point2` не более 2 км. Если передан параметр `q` — ограничения не накладываются. Параметр конфликтует с параметрами `point`, `polygon`.

point1

Координаты правой нижней вершины прямоугольной области в формате `lon, lat`, ограничивающей результаты выборки. Используется для фильтрации результатов в прямоугольной области. Максимальное расстояние между точками `point2` и `point1` не более 2 км. Если передан параметр `q` — ограничения не накладываются. Параметр конфликтует с параметрами `point`, `polygon`.

point2

Полигон в формате WKT. Используется для фильтрации результатов в произвольной области. Допустимая площадь полигона ~ 6 км^2. Если передан параметр q — ограничения не накладываются. Параметр конфликтует с параметрами `point`, `point1`, `point2`.

polygon

Радиус поиска в метрах. Ограничение: от 0 до 40000 — при наличии поискового запроса (q), от 0 до 2000 — при отсутствии. Значение по умолчанию: 250 — в сочетании с `point`, 0 — в сочетании с `lon`/`lat`. Используется для фильтрации результатов в окружности.

radius

Идентификатор региона. Обязателен, если не задано географическое ограничение поиска. Подробности про территориальное деление карты на регионы можно посмотреть в описании Regions API.


region_id

Идентификаторы станций метро, разделённые запятыми. Используется для фильтрации объектов по станциям метро. Максимальное количество — 50.

subway

Координаты левой верхней вершины прямоугольной области видимости в формате `lon, lat`. Параметры `viewpoint1` и `viewpoint2` передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

viewpoint1

Координаты правой нижней вершины прямоугольной области видимости в формате `lon, lat`. Параметры `viewpoint1` и `viewpoint2` передают область карты, куда смотрел пользователь перед вводом запроса. Используется как один из критериев для выбора, где нужны результаты, и для ранжирования. Не ограничивает жёстко результаты поиска только переданной областью.

viewpoint2

Указание поисковому движку способа ввода текста запроса:
  - `hardware_qwerty_keyboard` — физическая QWERTY-клавиатура
  - `on_screen_keyboard` — экранная touch screen клавиатура
  - `voice` — голосовой ввод
  - `hand_writing` — рукописный ввод
  - `scanning` — ввод который используется людьми с ограниченными возможностями. C помощью пальца или глазными движениями
  - `software_generated` — текст сгенерирован программным обеспечением
  - `other` — прочие типы ввода


search_input_method

Указание поисковому движку, что запрос является законченным (пользователь нажал на кнопку завершения ввода). Отключает префиксность, т.е. по "банк" не будет находиться "банкомат".

search_is_query_text_complete

Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя. В ранжирование всё ещё участвует популярность, реклама и другие параметры, но в меньшей степени.

search_nearby

Тип производимого поиска. Допустимые значения: <ul> <li>`discovery` — максимально широкий поиск с возможностью раскрытия связанных объектов (категории, соответствующие запросу, будут раскрыты до входящих в них компаний);</li> <li>`one_branch` — идентичен `discovery`, но для организации будет отдан только один филиал компании;</li> <li>`indoor` — конфигурация для качественного поиска компаний в здании. Допускает поиск по префиксу, как подсказчик. Для отключения префикса используйте `search_is_query_text_complete`;</li> <li>`ads` — идентичен `discovery`, но будут выданы только объекты с рекламой. Кроме того, для организации будет отдан только один первый по ранжированию филиал компании;</li> <li>`discovery_partial_searcher` — идентичен `discovery`, но будет задействовано больше вариантов пересечений связей;</li> <li>`discovery_partial_searcher_strict` — идентичен `discovery_partial_searcher`, но с выключенным префиксным поиском.</li> </ul>

search_type

Сортировка результатов. Допустимые значения: <ul> <li>`distance` — по возрастанию расстояния. Если передан параметр `sort_point`, `point` или `location`, то расстояние рассчитывается от этой точки до центра площадных геообъектов (городов, районов и т.д.) и по кратчайшему расстоянию до линейных (улиц). Иначе — по типу объекта и его площади; </li> <li>`relevance` — по убыванию релевантности. В поиске участвует название организации и категории, в которые входит организация. Учитывает максимум разных факторов: точность соответствия запроса объекту, популярность объектов, рейтинг, расположение, реклама и многое другое;</li> <li>`rating` — по убыванию рейтинга;</li> <li>`flamp_rating` — по убыванию рейтинга Флампа;</li> <li>`creation_time` — по убыванию даты создания компании;</li> <li>`opened_time` — по убыванию даты открытия;</li> <li>name — по наименованию (в алфавитном порядке по возрастанию).</li> </ul>

sort

Координаты точки, от которой производится сортировка (координаты точки в формате `lon, lat`). Устаревший параметр, вместо него нужно использовать параметр `location`.

sort_point

Типы объектов, среди которых производится поиск. При передаче нескольких типов менее релевантные результаты одних типов могут вытесниться более релевантными других типов. Типы перечисляются через запятую. Значение `adm_div` является псевдонимом для всех типов `adm_div.*` одновременно. Список доступных типов: <ul> <li>`branch` — компания;</li> <li>`building` — здание;</li> <li>`street` — улица;</li> <li>`parking` — парковка;</li> <li>`station` — остановки или станция общественного транспорта;</li> <li>`station.metro` — станция метро;</li> <li>`station_entrance` — вход на станцию;</li> <li>`station_platform` — остановочная платформа;</li> <li>`attraction` — достопримечательность;</li> <li>`crossroad` — перекрёсток;</li> <li>`gate` — проход/проезд;</li> <li>`road` — дорога;</li> <li>`route` — маршрут;</li> <li>`adm_div` — административная единица;</li> <li>`adm_div.city` — город;</li> <li>`adm_div.country` — страна;</li> <li>`adm_div.district_area` — район области;</li> <li>`adm_div.district` — район;</li> <li>`adm_div.division` — округ;</li> <li>`adm_div.living_area` — жилмассив, микрорайон;</li> <li>`adm_div.place` — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;</li> <li>`adm_div.region` — регион (область/край/республика и т.п.);</li> <li>`adm_div.settlement` — населённый пункт (деревня, посёлок и т.п.);</li> <li>`coordinates` — глобальная координата в системе координат WGS84 в формате lon, lat;</li> <li>`coordinates_additional` — дополнительная глобальная координата в системе координат WGS84 в формате lon, lat;</li> <li>`kilometer_road_sign` — знак километра.</li> </ul> Список доступных подтипов (`subtype`) для разных типов объектов можно посмотреть в схеме ответа внутри items.

type

Типы гео-объектов, среди которых производится поиск. При передаче нескольких типов менее релевантные результаты одних типов могут вытесниться более релевантными других типов. Типы перечисляются через запятую.

Значение `adm_div` является псевдонимом для всех типов `adm_div.*` одновременно.

Список доступных типов:

* `adm_div` — административная единица;
* `adm_div.city` — город;
* `adm_div.district_area` — район области;
* `adm_div.district` — район;
* `adm_div.division` — округ;
* `adm_div.living_area` — жилмассив, микрорайон;
* `adm_div.place` — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;
* `adm_div.region` — регион (область/край/республика и т.п.);
* `adm_div.settlement` — населённый пункт (деревня, посёлок и т.п.);
* `coordinates` — глобальная координата в системе координат WGS84 в формате lon, lat.


Типы гео-объектов, среди которых производится поиск. При передаче нескольких типов менее релевантные результаты одних типов могут вытесниться более релевантными других типов. Типы перечисляются через запятую.

Значение `adm_div` является псевдонимом для всех типов `adm_div.*` одновременно.

Список доступных типов:

* `adm_div` — административная единица;
* `adm_div.city` — город;
* `adm_div.district_area` — район области;
* `adm_div.district` — район;
* `adm_div.division` — округ;
* `adm_div.living_area` — жилмассив, микрорайон;
* `adm_div.place` — разные площадные объекты: парки, пляжи, территории баз отдыха, озёра и прочие места;
* `adm_div.region` — регион (область/край/республика и т.п.);
* `adm_div.settlement` — населённый пункт (деревня, посёлок и т.п.);
* `attraction` — достопримечательность;
* `building` — здание;
* `crossroad` — перекрёсток;
* `gate` — проход/проезд;
* `parking` — парковка;
* `road` — дорога;
* `street` — улица;
* `station_entrance` — вход на станцию;
* `station_platform` — остановочная платформа;
* `coordinates` — глобальная координата в системе координат WGS84 в формате lon, lat;
* `coordinates_additional` — дополнительная глобальная координата в системе координат WGS84 в формате lon, lat;
* `kilometer_road_sign` — знак километра.


Фильтрует объекты, у которых дата удаления позже, чем переданный параметр. Принимает значения в формате YYYY-MM-DD.

date

Идентификаторы категорий, в которых мог находится удаленный объект, разделённые запятыми.


rubrics

Идентификатор подъезда.

fias_code

Идентификатор объекта. Может также содержать уникальный хеш в формате id_hash. Необходим для формирования статистики. Можно также передать несколько идентификаторов через запятую, но не более 100. Идентификаторы не должны дублироваться. Реклама будет подобрана, если есть только один идентификатор в запросе.

Пример единичной записи с хэшом статистики

itin

Номер запрашиваемой страницы.

page

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

page_size

Номер телефона, по которому осуществляется поиск.

phone

Произвольная поисковая строка.

Тип обслуживающей организации.

Доступные типы:
  - default — городские обслуживающие организации;
  - internet — интернет провайдеры;
  - all — все перечисленные.


servicing_group

Веб-сайт, по которому осуществляется поиск.

site

trade_license

Время генерации рекламных весов в формате TIMESTAMP

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

Тип маршрута. 

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

 * `bus` — автобус;
 * `trolleybus` — троллейбус;
 * `tram` — трамвай;
 * `shuttle_bus` — маршрутное такси;
 * `metro` — метро;
 * `suburban_train` — электропоезд;
 * `funicular_railway` — фуникулёр;
 * `monorail` — монорельс;
 * `river_transport` — водный транспорт;
 * `cable_car` — канатная дорога;
 * `light_rail` — скоростной трамвай;
 * `premetro` — метротрам;
 * `light_metro` — лёгкое метро;
 * `aeroexpress` — аэроэкспресс.

Тип станции. 

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

 * `stop` — остановка городского наземного транспорта;
 * `railway` — железнодорожный вокзал;
 * `metro` — станция метро;
 * `river_transport` — речной порт;
 * `trolleybus` — троллейбус;
 * `tram` — трамвай;
 * `funicular_railway` — фуникулёр;
 * `monorail` — монорельс;
 * `cable_car` — канатная дорога;
 * `light_rail` — скоростной трамвай;
 * `premetro` — метротрам;
 * `light_metro` — лёгкое метро.

Массив контекстных категорий.

Объекты результата. 

Возможные типы объектов:

 * `branch` — филиал;
 * `adm_div` — административная единица;
 * `building` — здание;
 * `street` — улица;
 * `attraction` — достопримечательность;
 * `crossroad` — перекресток;
 * `parking` — парковка;
 * `road` — дорога;
 * `gate` — проход/проезд;
 * `route` — маршрут;
 * `station` — остановка;
 * `station_platform` — остановочная платформа;
 * `station_entrance` — вход на станцию;
 * `road` — дорога;
 * `project` — проект;
 * `coordinates` — глобальная координата;
 * `coordinates_additional` — дополнительная глобальная координата;
 * `kilometer_road_sign` — знак километра.

Информация о произведённом поиске.

Количество найденных объектов.

Объекты результата. 

Возможные типы объектов:

 * `branch` — филиал.

Группы обслуживающих организаций.

Геообъект типа административная единица.

Принадлежность к административной территории более высокого уровня.

Описание достопримечательности.

Название территории (для использования в функционале «поделиться», для конечных точек маршрута и т. д.).

Динамические свойства здания.

Время внесения информации о филиале в БД.

Детализированный тип административно-территориальной единицы.

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

 * `city` — город;
 * `microdistrict` — микрорайон;
 * `residential_district` — жилмассив;
 * `residential_quarter` — квартал;
 * `poselok` — посёлок;
 * `residential_complex` — жилой комплекс;
 * `selo` — село;
 * `derevnja` — деревня;
 * `cottage_estate` — коттеджный посёлок;
 * `urban_settlement` — посёлок городского типа;
 * `workers_settlement` — рабочий посёлок;
 * `dacha_settlement` — дачный посёлок;
 * `resort_settlement` — курортный посёлок;
 * `stanitsa` — станица;
 * `sloboda` — слобода;
 * `khutor` — хутор;
 * `aul` — аул;
 * `aal` — аал;
 * `town` — (военный) городок;
 * `farmstead` — заимка;
 * `vyselok` — выселок;
 * `municipality` — муниципальное образование;
 * `station` — станция;
 * `townhouse_settlement` — посёлок таунхаусов;
 * `territory` — территория;
 * `cooperative` — кооператив;
 * `partnership` — товарищество.

Код ФИАС. Поле доступно только в коммерческом API.

Код ФНС. Поле доступно только в коммерческом API.

Полное название территории.

Уникальный идентификатор геообъекта.

Если true, то проезд до объекта возможен, если false или отсутствует, то нет.

Связанные объекты.

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

 * `entrances` — точки входа;
 * `database_entrances` — точки входа;
 * `branches` — организации;
 * `servicing` — обслуживающие организации;
 * `providers` — провайдеры;
 * `airports` — аэропорты;
 * `parking` — парковки;
 * `nearest_parking` — ближайшие парковки;
 * `nearest_stations` — ближайшие остановки;
 * `railway_terminals` — железнодорожные вокзалы;
 * `bus_terminals` — автовокзалы;
 * `hotels` — отели;
 * `river_ports` — речные порты;
 * `seaports` — морские порты;
 * `attractions` — достопримечательности;
 * `landmarks` — ориентиры.

Код ОКАТО. Поле доступно только в коммерческом API.

Код ОКТМО. Поле доступно только в коммерческом API.

Координаты точки поиска, заданные в системе координат WGS84 в формате lon, lat.

Идентификатор региона.

Подсказка, соответствующая запросу. Поле доступно только в методах автодополнения.

Уникальный идентификатор сегмента.

Идентификатор источника данных об объекте. Если отсутсвует, источник данных — 2GIS.

Сводная информация об административной единице.

Подтип административной единицы.

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

 * `city` — город;
 * `settlement` — населённый пункт;
 * `division` — округ;
 * `district` — район;
 * `living_area` — жилмассив, микрорайон;
 * `place` — место;
 * `district_area` — район области;
 * `region` — регион (область/край/республика и т.п.).

Локализованное название типа населённого пункта (только для subtype = settlement).

Тип объекта. 

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

 * `adm_div` — административная единица.

adm_div

Геообъект типа достопримечательность.

Принадлежность к административной территории.

Название достопримечательности (для использования в функционале «поделиться», для конечных точек маршрута и т. д.).

Динамическая информация.

Внешний контент. Дополнительные данные, такие как данные о фотографиях.

Полное название достопримечательности.

Геометрия достопримечательности.

Уникальный идентификатор геообъекта

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

Уникальный идентификатор проекта.

Параметры результата поиска. Возвращается только в поисковых методах версии 3.0.

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

Тип объекта. 

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

 * `attraction` — достопримечательность.

attraction

Адрес, по которому располагается филиал организации.

Уточнение о местоположении филиала по указанному адресу.

Представление поля address в виде одной строки.

Псевдоним названия организации.

Собственное имя здания.

Динамические свойства филиала.

Численность сотрудников организации. Поле доступно только в коммерческом API. 

Доступные варианты:

 * нет данных
 * до 15
 * 16-100
 * 101-250
 * 251-1000
 * более 1000

Аттрибуты для электрозаправок.

Информация об этажах здания.

Количество этажей в здании.

Представление адреса в виде одной строки с указанием города.

Признак наличия информации о квартирах в здании

Уникальный идентификатор филиала организации.

Признак удаленного объекта

Индивидуальный номер налогоплательщика. Поле доступно только в коммерческом API.

Связанные объекты.

Возможные значения:
 * `entrances` — точки входа;
 * `database_entrances` — точки входа;
 * `branches` — организации;
 * `servicing` — обслуживающие организации;
 * `providers` — провайдеры;
 * `airports` — аэропорты;
 * `parking` — парковки;
 * `nearest_parking` — ближайшие парковки;
 * `nearest_stations` — ближайшие остановки;
 * `railway_terminals` — железнодорожные вокзалы;
 * `bus_terminals` — автовокзалы;
 * `hotels` — отели;
 * `river_ports` — речные порты;
 * `seaports` — морские порты;
 * `attractions` — достопримечательности;
 * `landmarks` — ориентиры.

Полное собственное название филиала или название организации.

Ссылка на оплату парковки (диплинк в другое приложение, на сайт).

Описание назначения здания.

Расписание работы филиала.

Информация о горнолыжном подъемнике.

Набор блокирующих атрибутов, соответствующих запросу.

Данные о количестве квартир и материале здания. Поле доступно только в коммерческом API.

Смещение таймзоны в минутах относительно UTC0.

Лицензия филиала. Поле доступно только в коммерческом API.

Тип объекта. 

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

 * `branch` — филиал организации.

branch

Геообъект типа здание.

Количество организаций в здании, на которые можно написать отзыв на flamp.ru

Название дома (для использования в функционале «поделиться», для конечных точек маршрута и т. д.).

Тип объекта. 

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

 * `building` — здание.

building

Значение группы, полученное из Sapphire.

Идентификатор рубрики.

Тип объекта. 

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

 * `coordinates` — глобальная координата;
 * `coordinates_additional` — дополнительная глобальная координата.

coordinates

Геообъект типа перекресток.

Название перекрестка (для использования в функционале «поделиться», для конечных точек маршрута и т. д.).

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

Геометрия перекрёстка.

Тип объекта. 

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

 * `crossroad` — перекресток.

crossroad

Локализованное название атрибута.

Максимальное значение атрибута, имеющееся в выборке.

Минимальное значение атрибута, имеющееся в выборке.

Количество организаций в рубрике.

Геообъект типа проход/проезд.

Доступность. 

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

 * `public` — общедоступный;
 * `paid` — платный;
 * `restricted` — для служебного пользования.

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

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

Тип заграждения. 

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

 * `gate` — ворота;
 * `gate_barrier` — шлагбаум;
 * `turnstile` — турникет;
 * `wicket` — калитка.

Полное название прохода или проезда.

Геометрия прохода или проезда.

Описание прохода или проезда.

Поиск компаний по коду ФИАС