Перейти к основному содержимому

Получение геообъекта по ID (deprecated)

API docs by Redocly

Справочник геообъектов (2.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Геокодинг

Получение информации о геообъекте

Выводит подробную информацию о геообъекте по его уникальному идентификатору.

query Parameters
key
required
string

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

id
required
string

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

hash
string

Базовый хеш из 16 символов. Используется для формирования статистики и показа рекламных опций.

locale
string
Examples:
  • locale=ar_AE - Арабский язык для ОАЭ
  • locale=ru_RU - Русский язык для России

Локаль, с которой производится поиск и отдаются результаты.
Список доступных локалей:

  • az_AZ — азербайджанский (Азербайджан);
  • ru_AZ — русский (Азербайджан);
  • hy_AM — армянский (Армения);
  • ru_AM — русский (Армения);
  • ar_BH — арабский (Бахрейн);
  • en_BH — английский (Бахрейн);
  • ru_BY — русский (Беларусь);
  • ka_GE — грузинский (Грузия);
  • ru_GE — русский (Грузия);
  • en_EG — английский (Египет);
  • ar_EG — арабский (Египет);
  • it_IT — итальянский (Италия);
  • en_IQ — английский (Ирак);
  • ar_IQ — арабский (Ирак);
  • kk_KZ — казахский (Казахстан);
  • ru_KZ — русский (Казахстан);
  • en_QA — английский (Катар);
  • ar_QA — арабский (Катар);
  • en_CY — английский (Кипр);
  • es_CL — испанский (Кипр);
  • ky_KG — кыргызский (Кыргызстан);
  • ru_KG — русский (Кыргызстан);
  • en_CN — английский (Китай);
  • zh_CN — китайский (Китай);
  • ru_CN — русский (Китай);
  • en_KW — английский (Кувейт);
  • ar_KW — арабский (Кувейт);
  • en_MA — английский (Марокко);
  • ar_MA — арабский (Марокко);
  • mn_MN — монгольский (Монголия);
  • en_MN — английский (Монголия);
  • en_AE — английский (ОАЭ);
  • ar_AE — арабский (ОАЭ);
  • en_OM — английский (Оман);
  • ar_OM — арабский (Оман);
  • en_RU — английский (Россия);
  • ar_RU — арабский (Россия);
  • es_RU — испанский (Россия);
  • it_RU — итальянский (Россия);
  • ru_RU — русский (Россия);
  • cs_RU — чешский (Россия);
  • en_SA — английский (Саудовская Аравия);
  • ar_SA — арабский (Саудовская Аравия);
  • ru_TJ — русский (Таджикистан);
  • tg_TJ — таджикский (Таджикистан);
  • ru_UZ — русский (Узбекистан);
  • uz_UZ — узбекский (Узбекистан);
  • cs_CZ — чешский (Чехия).

fields
Array of strings

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую.
Список доступных полей:

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

Responses

Response Schema:
required
object (ObjMeta)

Метаданные ответа

required
object

Основной результат

Response samples

Content type
{
  • "meta": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    },
  • "result": {
    • "total": 1,
    • "items": [
      ]
    }
}