Поиск мест. /3.0/items

Набор идентификаторов контекстных категорий с одинаковой группой релевантности, разделенных запятой. <group> — целое число больше или равное нулю, обозначающее приоритет одного набора контекстных категорий над другим, 0 — высший приоритет.

context_rubrics[<group>]

Click coordinates on the map. It is used when selecting ads.


click_point

Version of the shell. If the parameter has not been passed, the current version of the API will be taken.


Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Список полей с информацией о геометрии и адресе места: <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` — контакты компании;</li> <li>`items.schedule` — расписание работы компании;</li> <li>`items.access_comment` — локализованное название для типа доступа;</li> <li>`items.access_name` — локализованное название типа доступа;</li> <li>`items.access` — тип доступа для парковки;</li> <li>`items.attraction` — описание достопримечательности;</li> <li>`items.capacity` — вместимость парковки;</li> <li>`items.description` — описание геообъекта;</li> <li>`items.external_content` — дополнительные данные компании, такие как буклеты и фотографии;</li> <li>`items.flags` — список признаков объекта;</li> <li>`items.floors` — количество этажей;</li> <li>`items.is_paid` — является ли парковка платной;</li> <li>`items.level_count` — количество уровней парковки;</li> <li>`items.links` — связанные объекты;</li> <li>`items.name_ex` — составные части наименования объекта;</li> <li>`items.photos` — фотографии, связанные с компанией;</li> <li>`items.reviews` — отзывы об объекте;</li> <li>`items.statistics` — cводная информация о геообъекте;</li> </ul> Список служебных полей: <ul> <li>`cb` — контекстный баннер;</li> <li>`context_rubrics` — массив контекстных категорий;</li> <li>`dym` — блок «Возможно, вы имели ввиду»;</li> <li>`filters` — фильтры для дополнительного поиска;</li> <li>`hash` — базовый хеш;</li> <li>`items.address.is_conditional` — флаг «условного адреса»;</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.has_delivery` — есть доставка</li> <li>`items.has_goods` — загружен список товаров фирмы</li> <li>`items.has_payments` — есть возможность оплатить услуги фирмы онлайн</li> <li>`items.has_pinned_goods` — у фирмы включен блок «Закрепленные товары»</li> <li>`items.has_realty` — есть недвижимость на продаже</li> <li>`items.is_main_in_group` — признак того, что это главный объект в группе объектов гибрида.</li> <li>`items.is_promoted` — фирма участвует в промо-акции Чека</li> <li>`items.is_routing_available` — флаг, возможен ли проезд до объекта;</li> <li>`items.locale` — текущая локаль для региона;</li> <li>`items.reg_bc_url` — URL для регистрации бизнес-коннекшна просмотра профиля;</li> <li>`items.region_id` — уникальный идентификатор проекта;</li> <li>`items.stat` — данные для формирования сообщений статистики;</li> <li>`items.stop_factors` — набор блокирующих атрибутов, соответствующих запросу;</li> <li>`request_type` — тип поискового запроса;</li> <li>`search_attributes` — информация о произведённом поиске;</li> <li>`widgets` — виджеты;</li> </ul>

fields

To include in the sample remote objects. Can be either true or false.

allow_deleted

Filter by presence of delivery. Takes the values true or false.

has_delivery

Filter by availability of the individual taxpayer identification number. It takes the true or false values.

has_itin

Filter by availability of photos. Takes the true or false values.

has_photos

Filter by availability of rating on flamp.ru. Takes the true or false values.

has_rating

Filter by availability of reviews on flamp.ru. Takes the true or false values.

has_reviews

Filter by availability of reviews on flamp.ru. Unlike has_reviews, the link status in 2GIS is not taken into account. It takes the true or false values.

has_reviews_on_flamp

Filter by availability of website. Takes the true or false values.

has_site

Filter by availability of the trading license. Takes the true or false values.

has_trade_license

Whether it is allowed to post reviews for companies on flamp.ru. It takes the true or false values.

is_reviewable_on_flamp

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

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

Basic hash consisting of 16 characters. It is used to generate statistics and display advertising options.

hash

The IDs of the buildings, separated by commas. They are used to filter objects in a building. The maximum number is 50.

building_id

The IDs of the cities separated by commas. They are used to filter objects by cities. The maximum number is 50.

city_id

The IDs of the districts, separated by commas. They are used to filter objects by district. The maximum number is 50.

district_id

A sign of an obvious change of scope boundaries. Takes the true or false values.


is_viewport_change

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

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

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

point

Координаты левой верхней вершины прямоугольной области в формате `lon, lat`, ограничивающей результаты выборки. Используется для фильтрации результатов в прямоугольной области. Допустимая разность координат `point2` и `point1` не более: для lon 0.06, для lat 0.04 (приблизительно 6.6 х 4.4 км). Если передан параметр `q` — ограничения не накладываются.

point1

Координаты правой нижней вершины прямоугольной области в формате `lon, lat`, ограничивающей результаты выборки. Используется для фильтрации результатов в прямоугольной области. Допустимая разность координат `point2` и `point1` не более: для lon 0.06, для lat 0.04 (приблизительно 6.6 х 4.4 км). Если передан параметр `q` — ограничения не накладываются.

point2

Полигон в формате WKT. Используется для фильтрации результатов в произвольной области.

polygon

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

radius

Region identifier. It is required if a geographical limit of search has not been specified.


region_id

Координаты левой верхней вершины прямоугольной области видимости в формате `lon, lat`.

viewpoint1

Координаты правой нижней вершины прямоугольной области видимости в формате `lon, lat`.

viewpoint2

Тип производимого поиска. Допустимые значения: <ul> <li>`discovery` — максимально широкий поиск с возможностью раскрытия связанных объектов (категории, соответсвующие запросу, будут раскрыты до входящих в них компаний);</li> <li>`one_branch` — идентичен `discovery`, но для организации будет отдан только один филиал компании;</li> <li>`indoor` — конфигурация для качественного поиска компаний в здании;</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`, то расстояние рассчитывается до этой точки;</li> <li>`relevance` — по убыванию релевантности. В поиске участвует название организации и категории, в которые входит организация;</li> <li>`rating` — по убыванию рейтинга;</li> <li>`flamp_rating` — по убыванию рейтинга флампа;</li> <li>`general_rating` — по убыванию рейтинга (алиас `rating`);</li> <li>`distance_without_ads` — по возрастанию расстояния аналогично `distance`, но без учёта рекламных весов;</li> <li>`creation_time` — по убыванию даты создания компании;</li> <li>`opened_time` — по убыванию даты открытия.</li> </ul>

sort

Координаты точки, от которой производится сортировка (координаты точки в формате `lon, lat`).

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>`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` — глобальная координата.</li> </ul>

type

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

date

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


rubrics

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

An example of a single record hasham statistics

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

page

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

page_size

Phone number, which is used for the search.

phone

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

site

The time when the advertising weights were generated in the TIMESTAMP format

Available, if you can use color coding, for example for metro stations.

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

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

 * `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` — лёгкое метро.

Map object of the administrative unit type.

Belonging to the administrative territory of a higher level.

Territory name (to use it for the "share" functionality, for final points of the route, etc.).

The time when the information on the branch was added to the database.

The object was not found by ID, and using geocoding for this coordinate

A sign that it is the main object in the group of the hybrid objects.

If true, it is possible to travel toward the object, if false or unavailable, then it is not.

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

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

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

The coordinates of the search point specified in the WGS84 coordinate system in the lon, lat format.

A suggest corresponding to the request. The field is available only in autocomplete methods.

The ID of the object data source. If absent, the data source is 2GIS.

Summary information about the administrative unit.

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

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

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

Localized name of the type of settlement (only for subtype = settlement).

Тип объекта. 

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

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

adm_div

Belonging to the administrative territory.

Attraction name (to use it for the "share" functionality, for final points of the route, etc.).

External content. Additional data such as data about pictures.

Parameters of the search result. It is only returned in search methods of the version 3.0.

Localized name of the type of attraction.

Тип объекта. 

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

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

attraction

Address where a company branch is located.

Clarification on the branch location at the specified address.

Presentation of the address field as a single string.

Full proper name of the branch or a company name.

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

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

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

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

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

A sign that the firm has delivery service

A sign that you can pay for the services of the company online

The firm has included a block of "Fixed products".

A sign of whether there is any real estate on sale in the building

Company participates in the promo event of "Check"

Individual taxpayer identification number. This field is available only for commercial API.

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

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

Available metacategories for showing the list of companies in a hybrid object.

Description of the purpose of the building.

A set of blocking attributes that match the query.

The data on the number of apartments and the material the building is made of. This field is available only for commercial API.

The time zone of the object in POSIX format.

Timezone offset in minutes with respect to UTC0.

The license of the branch. This field is available only for commercial API.

Тип объекта. 

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

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

branch

Number of companies in the building for which you can write reviews on flamp.ru

Building name (to use it for the "share" functionality, for final points of the route, etc.).

Information about floors of the building.

Whether in the building of service providers with the ability to pay for their services online

Available metacategories for showing the list of companies in this building.

Тип объекта. 

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

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

building

Тип объекта. 

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

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

coordinates

Crossing name (to use it for the "share" functionality, for final points of the route, etc.).

Тип объекта. 

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

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

crossroad

Map object of the passage/thoroughfare type.

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

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

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

Comment about availability. For example, there may be specified a cost for the paid passage.

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

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

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

Full name of the passage or thoroughfare.

Description of the passage or thoroughfare.

Тип прохода или проезда. 

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

 * `main` — основной;
 * `additional` — дополнительный;
 * `service` — служебный.

Тип объекта. 

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

 * `gate` — проход/проезд.

gate

Short caption for the icon to be displayed in the UI.

A search string that is put in a search string and that is passed to the query to generate the search results.

The ID of a metacategory the branches of which it is necessary to find.

Тип доступа. 

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

 * `public` — общедоступная;
 * `handicapped_only` — только для инвалидов;
 * `customers_only` — только для клиентов;
 * `residents_only` — только для резидентов.

Comment about payment, additional restrictions, etc.

Address of the building where the parking lot is located.

Parking lot name (to use it for the "share" functionality, for final points of the route, etc.).

Comment. The field is meant for specifying any additional information about the parking lot.

Назначение парковки. 

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

 * `car` — для автомобилей;
 * `bike` — для велосипедов;
 * `motorbike` — для мотоциклов/мопедов.

Тип парковки. 

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

 * `ground` — наземная;
 * `underground` — подземная;
 * `multilevel` — многоуровневая.

Тип объекта. 

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

 * `parking` — парковка.

parking

Тип объекта. 

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

 * `project` — проект.

project

Road name (to use it for the "share" functionality, for final points of the route, etc.).

Тип объекта.

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

 * `road` — дорога.

road

Object name (to use it for the "share" functionality, for final points of the route, etc.).

Route color, if any. For example, for metro lines. Format: "#rrggbb

The name of the starting point of the route.

Тип объекта.

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

 * `route` — маршрут.

route

Whether there was a geo-restriction in the following query text: "school in Pervomaisk".

A sign that the most relevant result was found by a partial match.

Тип объекта.

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

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

Stopping point name (to use it for the "share" functionality, for final points of the route, etc.).

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

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

 * `entrances` — входы на станцию;
 * `database_entrances` — точки входа;
 * `nearest_stations` — расположенные поблизости остановки, в том числе переходы на другие станции метро, помимо станции, связанной со входом.

Transport routes passing through the station or stop.

Тип объекта.

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

 * `station` — остановка.

station

Presents the address field as a single string ready to be displayed to a user.

Name of the entrance to the stop (to use it for the "share" functionality, for final points of the route, etc.).

Public transport routes passing through the stopping point.

The unique identifier of the station to which the entrance is linked.

Information about the material the building is made of. This field is available only for commercial API.

Тип объекта. 

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

 * `station_entrance` — вход на станцию.

station_entrance

Stopping platform name (to use it for the "share" functionality, for final points of the route, etc.).

Unique identifier of the stopping platform.

The unique identifier of the stop to which this stopping platform is linked.

Тип объекта. 

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

 * `station_platform` — остановочная платформа.

station_platform

Street name (to use it for the "share" functionality, for final points of the route, etc.).

Тип объекта. 

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

 * `street` — улица.