Геокодирование. /3.0/items/geocode

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Список полей с информацией о геометрии и адресе места: <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.city_alias` — алиас города, в котором находится объект;</li> <li>`items.is_promoted` — фирма участвует в промо-акции Чека;</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.stat` — данные для формирования сообщений статистики;</li> <li>`items.stop_factors` — набор блокирующих атрибутов, соответствующих запросу;</li> <li>`request_type` — тип поискового запроса;</li> <li>`search_attributes` — информация о произведённом поиске;</li> <li>`widgets` — виджеты;</li> </ul>

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

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

fields

Фильтр по наличию индивидуального номера налогоплательщика. Принимает значения: 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.


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

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

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

building_id

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

city_id

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

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

district_id

Широта точки — центра области поиска. Обязательно использование совместно с параметром `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_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. Идентификаторы не должны дублироваться. Реклама будет подобрана, если есть только один идентификатор в запросе.

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

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

page

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

page_size

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

phone

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

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

site

Время генерации рекламных весов в формате 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` — лёгкое метро.

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

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

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

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

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

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

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

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

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

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

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

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

Координаты точки поиска, заданные в системе координат 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

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

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

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

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

Тип объекта. 

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

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

crossroad

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Тип объекта. 

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

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

gate

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

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

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

Короткая подпись к иконке для отображения в UI.

Ссылка на SVG-изображение.

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

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

Заголовок для отображения в UI.

CTA для раскрытия метарубрики.

Идентификатор метарубрики, филиалы которой требуется найти.

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

Тип доступа. 

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

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

Комментарий про платность, про дополнительные ограничения и пр.

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

Адрес здания, в котором находится парковка.

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

Комментарий. Поле предназначено для добавления какой-либо дополнительной информации о парковке.

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

Является ли парковка перехватывающей.

Является ли парковка платной.

Количество уровней парковки.

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

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

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

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

Расписание работы парковки.

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

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

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

Временная зона объекта в формате POSIX.

Тип объекта. 

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

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