Информация о регионе

Регион — это агломерация, включающая крупный город и ближайшие населённые пункты. Теперь можно реализовать выбор города, как это сделано в Онлайн-версии 2ГИС, являющейся партнёром API.

URL: http://catalog.api.2gis.ru/2.0/region/get

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка

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

Пример: 1234567890.

id Да Строка

Идентификатор региона. Можно также передать несколько идентификаторов через запятую

Примеры:

  • 1
  • 1,5,10

format Нет Строка Формат ответа. Может принимать значения:
  • xml
  • json
  • jsonp
По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания отобразится ошибка в формате json.

Пример: myCallback

locale Нет Строка Локаль на которой отдавать результат. Возможные значения:
  • cs_CZ
  • en_CY
  • es_CL
  • it_IT
  • ru_RU
  • ru_KZ
  • ru_UA
  • en_AE
  • ar_AE
  • ru_KG
  • uk_UA
По умолчанию используется ru_RU.
fields Нет Строка

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

  • items.name_grammatical_cases
  • items.domain
  • items.locales
  • items.time_zone
  • items.bounds
  • items.statistics
  • items.locale
  • items.settlements
  • items.satellites

Параметры ответа

Параметр Тип Описание
meta* Структура

Общая информация об ответе

result* Структура

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

Общая информация об ответе (meta)
Параметр Тип Описание
code* Целое число

Код ответа API. Подробнее см. Коды ответов

Основной результат (result)
Параметр Тип Описание
total* Целое число

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

items* Массив структур

Массив найденных объектов

Массив найденных объектов (items)
Параметр Тип Описание
id* Строка

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

type* Строка

Допустимые значения:

  • region

name* Строка

Название региона.

Примеры:

  • Москва

name_grammatical_cases Структура | Null

Склонение названия региона

Входит в ответ, если указать items.name_grammatical_cases в fields.

time_zone Структура | Null

Часовой пояс

Входит в ответ, если указать items.time_zone в fields.

statistics Структура | Null

Статистика по региону

Входит в ответ, если указать items.statistics в fields.

domain Строка

Значение домена

Входит в ответ, если указать items.domain в fields.

Примеры:

  • ru

locale Строка

Текущая локаль для региона.

Входит в ответ, если указать items.locale в fields.

Примеры:

  • ru_RU
  • it_IT

locales Массив

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

Входит в ответ, если указать items.locales в fields.

Примеры:

  • cs_CZ
  • en_CY
  • es_CL
  • it_IT
  • ru_RU
  • ru_KZ
  • ru_UA
  • en_AE
  • ar_AE
  • ru_KG
  • uk_UA

settlements Массив

Список городов-спутников.

Входит в ответ, если указать items.settlements в fields.

satellites Массив структур

Список городов-спутников в виде объектов

Входит в ответ, если указать items.satellites в fields.

bounds Строка | Null

Геометрия границ проекта в формате WKT.

Входит в ответ, если указать items.bounds в fields.

Примеры:

  • POLYGON((83.4457915421126 53.4866943332863,84.0879338133862 53.4866943332863,84.0879338133862 53.1585977185895,83.4457915421126 53.1585977185895,83.4457915421126 53.4866943332863)

hidden Булев

Флаг - является ли проект скрытым

weights_time Целое число

Время последнего обновления рекламных весов в формате Unix timestamp

Склонение названия региона (items.name_grammatical_cases)
Параметр Тип Описание
genitive Строка

В родительном падеже.

Примеры:

  • Новосибирска

prepositional Строка

В предложном падеже.

Примеры:

  • Новосибирске

accusative Строка

В винительном падеже.

Примеры:

  • Новосибирск

dative Строка

В дательном падеже.

Примеры:

  • Новосибирску

Часовой пояс (items.time_zone)
Параметр Тип Описание
name Строка

Часовой пояс в формате Time Zone Database.

Примеры:

  • Asia/Novosibirsk
  • Europe/Moscow
  • Indian/Chagos

offset Целое число

Сдвиг времени относительно Гринвича в минутах

Примеры:

  • 420
  • 240
  • 360

Статистика по региону (items.statistics)
Параметр Тип Описание
rubric_count Целое число

Количество рубрик в регионе

org_count Целое число

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

branch_count Целое число

Количество филиалов в регионе.

route_count Целое число

Количество маршрутов общественного транспорта.

Список городов-спутников в виде объектов (items.satellites)
Параметр Тип Описание
id* Строка

Идентификатор населенного пункта.

name* Строка

Имя населенного пункта.

geometry* Строка

Геометрия населенного пункта.

centroid* Строка

Центроид населенного пункта.

Примеры

Информация о регионе с идентификатором 1

Запрос:

http://catalog.api.2gis.ru/2.0/region/get?id=1&key=1234567890

Ответ:

Информация о регионе с идентификатором 1 и дополнительными полями

Запрос:

http://catalog.api.2gis.ru/2.0/region/get?id=1&fields=items.locales,items.bounds&key=1234567890

Ответ: