Дополнительные поля, которые необходимо отобразить в ответе.

Список доступных полей:

* `items.rubric_ids` — идентификаторы известных рубрик для объекта;
* `items.floor_id` — идентификатор этажа;
* `items.name` — название объекта;
* `items.trade_license` — лицензия филиала;


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

Пример единичного поля

fields

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Список доступных полей: <ul> <li>`items.name` — название объекта;</li> <li>`items.org` — организация, к которой относится филиал;</li> <li>`items.context` — динамическая информация;</li> <li>`items.stop_factors` — набор блокирующих атрибутов, соответствующих запросу;</li> <li>`items.schedule` — расписание работы;</li> <li>`items.schedule_special` — особое расписание работы;</li> <li>`items.reviews` — статистика по отзывам;</li> <li>`items.temporary_unavailable_atm_services` — признак наличия неработающих услуг у банкомата или терминала;</li> <li>`items.name_back` — для дорожного знака локализованное название в обратном направлении при наличии;</li> <li>`items.value_back` — для дорожного знака номер километра в обратном направлении;</li> <li>`items.has_ads_model` — признак наличия рекламной 3D модели в здании;</li> <li>`items.floor_id` — идентификатор этажа;</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

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


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

location

Высота в пикселях DOM-объекта, отображающего карту.

map_height

Ширина в пикселях DOM-объекта, отображающего карту.

map_width

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

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

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

building_id

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

city_id

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

district_id

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

place_id

Центр области поиска (координаты точки в формате `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

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

page

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

page_size

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

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

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

Тип объекта. 

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

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

coordinates

Маркер координаты

Идентификаторы элементов из расширенного контекста результата.

Точность найденного адреса:

 * `none` - адрес не распознан;
 * `other` - улица не найдена, но найден город/село и т.п.;
 * `street` - найдена улица, но не найден дом;
 * `near` - номер дома не найден, но нашёлся дом с близком номером на той же улице;
 * `number` - найден дом с нужным номером, но отличающимся номером строения/корпуса;
 * `exact` - найден дом с нужным номером и номером строения/корпуса.

Внешний источник результата.

 * 0 - None, результат внутренний;
 * 1 - AiVectorSearch, результат получен от сервиса векторного AI поиска.

Размеченная часть подсказки.

Строка подсказки для suggest.

Идентификатор геометрии, к которой принадлежит маркер.

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

Флаг, указывающий на рекламодателя.

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

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

Идентификаторы известных рубрик.

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

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

Маркер объекта

Рекламные материалы данного филиала.

Описание кластеризованного объекта.

Количество результатов в кластере.

Количество результатов в geometry_id.

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

Организация, к которой относится филиал.

Отзывы бранчей.

Отзывы геообъектов.

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

Особое время работы филиала.

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

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

Дата последнего обновления данных.

Расчитаный на основе viewpoint и размера экрана zoom.

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

Расстояние до некой точки в метрах. Считается относительно переданной в запросе точки в параметре `point` или `sort_point`, и переданном параметре `sort=distance`.

Попадает ли объект в границы сортировки.

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

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

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

Список признаков объекта.

Признак наличия у здания 3D модели на карте. Присутствует только, если значение равно true.

Заполняется только для type=city и принимает единственное значение true в случае, если город является главным городом текущего проекта (например Новосибирск)

Заполняется только для type=adm_div, subtype=city|settlement и принимает единственное значение true в случае, если населённый пункт является районным центром.

Заполняется только для type=adm_div, subtype=city|settlement и принимает единственное значение true в случае, если населённый пункт является областным центром.

Есть ли для объекта фотографии.

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

Дополнительные сведения о временно не работающем филиале.

Микрокомментарий маркера

Структура рекламных опций.

Список действий по внешним рекламным ресурсам.

Логотип рекламодателя для маркера.

Составные части наименования организации.

Дополнительная информация к названию филиала, которая должна быть показана в развёрнутой карточке.

Расширение имени филиала.

Юридическое название филиала

Собственное имя филиала.

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

Имя действия. Если поле отсутствует, используют для подписи общую локализованную фразу «Узнать больше».

Тип действия.

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

 * link — web-ссылка;
 * phone — звонок по указанному телефону;
 * callback — заказ обратного звонка;
 * open_card — открытие карточки объекта справочника;
 * search_by_org — найти все филиалы организации;
 * search_by_rubric — найти все филиалы рубрики;
 * search_by_query — выполнить поиск по тексту;
 * search_buy_here - раскрыть список доноров ЗМК;
 * search_by_meta_rubric - найти все филиалы метарубрики;
 * miniapp_yclients - запуск miniapp yclients, только внутри buy_here, добавляется в конец списка;
 * miniapp_otello - запуск miniapp otello, только внутри buy_here, добавляется в конец списка.

Соответствие типов действия и значений поля value:

 * link — URL страницы, которую требуется открыть;
 * phone — телефон в формате +<цифры без разделителей>;
 * callback — URL страницы, на которую требуется отправить данные для заказа обратного звонка;
 * open_card — идентификатор объекта справочника, карточку которого требуется открыть;
 * search_by_org — идентификатор организации, филиалы которой требуется найти;
 * search_by_rubric — идентификатор рубрики, филиалы которой требуется найти;
 * search_by_query — текст запроса, по которому требуется выполнить поиск;
 * search_buy_here - список adsId из объектов массива опции buy_here_owner, перечисленных через запятую;
 * miniapp_yclients - данные для запуска miniapp yclients;
 * miniapp_otello - данные для запуска miniapp otello.

Описание свойств организации.

Количество филиалов данной организации.

Наименование, указанное в карточке организации.

Собственное имя организации.

Наименование бренда в карточке организации.

URL для регистрации бизнес-коннекшна просмотра профиля.

Общее количество отзывов.

Общее количество отзывов (включая отзывы без текста)

Нужно ли показывать отзывы на всю организацию по умолчанию вместо одного филиала. Принимает значение true, если у каждого филиала фирмы, у которого включены отзывы, присутствует более 50% рубрик из списка.

Можно ли отображать отзывы к этому филиалу, а также создавать новые отзывы.

Средний рейтинг организации. Рассчитывается как среднее арифметическое рейтингов филиалов.

Общее количество отзывов организации

Общее количество отзывов организации (сумма поля general_review_count_with_stars по всем филиалам)

Рейтинг филиала на сервисе Flamp.

Количество отзывов на сервисе Flamp.

Разрешено ли отображать отзывы к этому объекту, а также создавать новые отзывы.

Разрешено ли оставлять отзывы к данному объекту на сервисе Flamp.

Описание расписания работы.

Дата начала изменений в расписании работы. Формат: "YYYY-MM-DD"

Дата конца изменений в расписании работы. Формат: "YYYY-MM-DD"

Локализованное описание возможных изменений во времени работы. Применяется для праздников, временных ограничений и т.д.

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

Интервалы времени работы.

Список интервалов работы в указанную дату.

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

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

Сообщает, является ли текст подсказанным:

 * true - текст сгенерирован подсказчиком;
 * false - текст совпадает с частью запроса.

Текст части подсказки.

Имя дополнительного атрибута.

Дата, до которой действует лицензия

Форма собственности компании (Общество с ограниченной ответственностью, Публичное акционерное общество и т.п.)

Дата, от которой действует лицензия

Тип лицензии (коммерческая, промышленная, профессиональная и т.п.)

Статус лицензии (активная, отозванная и пр.)

2GIS API Support

Каталог маркеров объектов

Возвращает коллекцию маркеров, удовлетворяющих параметрам, переданным в запросе.
Маркер является представлением объекта на карте, таким образом маркером может быть только объект с координатами.


Получение коллекции маркеров

Маркеры