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

Получение региона по id

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

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

branch_id
required
string

Идентификатор филиала. Конфликтует с параметром id. Необходим для получения региона.

fields
Array of strings

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

  • items.name_grammatical_cases — cклонение названия региона;
  • items.domain — значение домена;
  • items.locales — список локалей, на которых возможен поиск для данного региона;
  • items.time_zone — часовой пояс;
  • items.bounds — геометрия границ проекта в формате WKT;
  • items.statistics — статистика по региону;
  • items.locale — текущая локаль для региона;
  • items.settlements — список городов-спутников;
  • items.satellites — список городов-спутников в виде объектов;
  • items.code — код региона;
  • items.uri_code — код региона, который будет отображаться в домене;
  • items.uri_aliases — набор алиасов региона;
  • items.allow_for_indexing — список языков проекта, на которых разрешено индексировать;
  • items.country_code — код страны;
  • items.default_pos — позиция по умолчанию для отображения проекта;
  • items.zoom_level — уровень масштаба;
  • items.flags — признаки наличия определённой информации в регионе;
  • items.seo — дополнительные поля для SEO.

Responses

Response Schema:
required
object (ObjMeta)

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

required
object

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

Response samples

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