Геокодирование. /2.0/geo/search

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. <br>Список доступных полей: <ul> <li>`items.adm_div` — административная единица;</li> <li>`items.address` — адрес, по которому располагается филиал организации;</li> <li>`items.full_address_name` — то же, что и address_name, но с указанием города;</li> <li>`items.floors` — количество этажей;</li> <li>`items.attraction` — описание достопримечательности;</li> <li>`items.statistics` — cводная информация о геообъекте;</li> <li>`items.level_count` — количество уровней парковки;</li> <li>`items.capacity` — вместимость парковки;</li> <li>`items.description` — описание геообъекта;</li> <li>`items.context` — динамическая информация;</li> <li>`items.access_name` — локализованное название типа доступа;</li> <li>`items.is_paid` — является ли парковка платной;</li> <li>`items.for_trucks` — парковка для грузовиков;</li> <li>`items.paving_type` — тип покрытия парковки;</li> <li>`items.access` — тип доступа для парковки;</li> <li>`items.access_comment` — локализованное название для типа доступа;</li> <li>`items.schedule` — расписание работы для гееобъекта (например, для парковки);</li> <li>`hash` — базовый хеш;</li> <li>`items.stat` — данные для формирования сообщений статистики;</li> <li>`search_attributes` — информация о произведённом поиске;</li> <li>`items.geometry.selection` — геометрия для выделения объекта;</li> <li>`items.geometry.hover` — геометрия области, используемой для определения попадания курсора в зону объекта;</li> <li>`items.geometry.style` — идентификатор стиля для отображения;</li> <li>`items.geometry.centroid` — визуальный центр геометрии объекта;</li> <li>`items.region_id` — уникальный идентификатор проекта;</li> <li>`items.links` — связанные объекты;</li> <li>`items.external_content` — дополнительные данные филиала, такие как буклеты и фотографии;</li> <li>`items.is_routing_available` — флаг, возможен ли проезд до объекта;</li> <li>`items.group` — связанные в объединённую карточку объекты;</li> <li>`items.reviews` — статистика по отзывам о филиале;</li> <li>`items.is_main_in_group` — признак того, что это главный объект в группе объектов гибрида;</li> <li>`items.city_alias` — алиас города, в котором находится объект;</li> <li>`items.detailed_subtype` — детализированный тип административно-территориальной единицы;</li> <li>`items.name_back` — локализованное название в обратном направлении при наличии;</li> <li>`items.value_back` — номер километра в обратном направлении;</li> </ul>

fields

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

has_photos

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

viewpoint1

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

viewpoint2

Фильтр по типам геообъектов, типы перечисляются через запятую. <br>Значение `adm_div` является псевдонимом для всех типов `adm_div.*` одновременно. <br>Список доступных типов: <ul> <li>`adm_div` — административная единица;</li> <li>`adm_div.city` — город;</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.settlement` — населённый пункт (деревня, посёлок и т.п.);</li> <li>`adm_div.district_area` — район области;</li> <li>`adm_div.region` — регион (область/край/республика и т.п.);</li> <li>`attraction` — достопримечательность;</li> <li>`building` — здание;</li> <li>`crossroad` — перекресток;</li> <li>`gate` — проход/проезд;</li> <li>`parking` — парковка;</li> <li>`poi` — POI;</li> <li>`road` — дорога;</li> <li>`street` — улица;</li> <li>`kilometer_road_sign` — знак километра.</li> </ul>

type

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

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

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

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

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

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

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

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

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

 * `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.

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

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

Если 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 в виде одной строки.

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

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

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

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

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

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

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

Тип объекта. 

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

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

building

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

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

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

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

Тип объекта. 

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

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

crossroad

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Тип объекта. 

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

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

gate

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

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

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

Геообъект типа километровый дорожный знак.

Локализованное название, включающее номер километра, единицу измерения и название трассы/улицы.

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

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

Тип объекта. 

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

 * `kilometer_road_sign` — километровый дорожный знак.

Номер километра в обратном направлении.

kilometer_road_sign

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

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

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

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

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

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

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

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

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

Тип доступа. 

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

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

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

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

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

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

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

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

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

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

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

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

Тип покрытия парковки:

 * `asphalt` — асфальтированное покрытие;
 * `concrete` — бетонное покрытие;
 * `gravel` — гравийное покрытие;
 * `unpaved` — без покрытия.

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

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

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

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

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

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

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

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

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

Тип объекта. 

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

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

parking

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

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

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

Собственное название дороги.

Сводная информация о дороге.

Тип объекта.

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

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

road

Признак того, что в запросе требуются ближайшие объекты.

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

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

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

Полное название улицы.

Сводная информация об улице.

Тип объекта. 

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

 * `street` — улица.

street

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

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

Название здания (в адресе для филиалов).

Массив компонентов адреса. 

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

 * `street_number` — типичный адрес;
 * `number` — только номер дома;
 * `location` — универсальное описание.

Универсальное описание.

Словесное описание местоположения строения.

location

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

number

Номер дома, включая дроби, корпуса и буквенные обозначения.

street_number

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

Идентификатор объекта административной единицы.

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

Тип объекта административной единицы. 

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

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

Уникальный идентификатор объекта достопримечательности.

Описание особых мест для парковки.

Алиас города, в котором находится объект.

Уточняющая информация о контакте.

Значение контакта для вывода на принтер.

Значение контакта для вывода на экран.

Тип контакта.

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

 * `email` — электронная почта;
 * `website` — сайт, протокол http;
 * `phone` — телефон;
 * `fax` — факс;
 * `icq` — аккаунт в ICQ;
 * `jabber` — Jabber;
 * `skype` — Skype;
 * `vkontakte` — ВКонтакте;
 * `twitter` — Twitter;
 * `instagram` — Instagram;
 * `facebook` — Facebook;
 * `pobox` — P.O.Box (абонентский ящик);
 * `youtube` — Youtube;
 * `odnoklassniki` — ok.ru;
 * `googleplus` — Google +;
 * `linkedin` — Linkedin;
 * `pinterest` — Pinterest; `whatsapp` — Whatsapp; `telegram` — Telegram; `viber` — Viber; `jivo` — Jivo.

Ссылка на сайт или социальную сеть.

Техническое значение контакта.

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

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

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

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

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

Дата открытия организации в формате ISO 8601.

Дата удаления организации из базы в формате ISO 8601.

Дата последнего изменения информации об организации в формате ISO 8601.

Дополнительные данные филиала, такие как буклеты и фотографии.

Количество фотографий в альбоме.

URL первой фотографии альбома.

Код альбома.

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

 * `common`;
 * `view`;
 * `facilities`.

URL основного фото персональной страницы филиала в справочнике 2ГИС.

Тип буклета.

Возможные значения:
 * `buildings`;
 * `saunas`.

Заголовок персональной страницы филиала в справочнике 2ГИС.

Адрес персональной страницы филиала в справочнике 2ГИС.

Код персональной страницы филиала в справочнике 2ГИС.

URL основного фото скидок филиала в справочнике 2ГИС.

Адрес скидок филиала в справочнике 2ГИС.

Код скидок филиала в справочнике 2ГИС.

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

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

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

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

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

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

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

Идентификатор этажа по умолчанию для отображения на карте при показе этажей здания.

Массив этажей здания. Сортировка: от нижних этажей к верхним.

Визуальный центр геометрии объекта.

Геометрия области, используемой для определения попадания курсора в зону объекта.

Геометрия для выделения объекта.

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

Признак того, что это главный объект в группе объектов гибрида.

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

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

Подтип поглощенного объекта. 

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

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

Тип объекта.

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

 * `branch` — филиал;
 * `building` — здание;
 * `attraction` — достопримечательность;
 * `adm_div` — административная территория;
 * `station` — остановка;
 * `station_platform` — остановочная платформа;
 * `station_entrance` — вход на станцию.

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

Ближайшие станции метро.

Ближайшие остановочные платформы.

Железнодорожные вокзалы.

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

Количество  аэропортов.