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

Список всех регионов

API docs by Redocly

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

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

Регионы

Получение списка регионов по параметрам

Осуществляет выдачу списка всех существующих регионов по заданным параметрам.

query Parameters
key
required
string

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

page
integer
Default: 1

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

page_size
integer [ 1 .. 2000 ]
Default: 1000

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

locale
string

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

locale_filter
Array of strings
Example: locale_filter=ru_RU

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

country_code_filter
string
Example: country_code_filter=ru

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

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;
  • items.hidden — флаг, является ли проект скрытым;
  • items.weights_time — время последнего обновления рекламных весов в формате Unix timestamp.

type
string
Default: "region"
Examples:
  • type=region,segment - Пример нескольких типов
  • type=region - Пример единичного типа

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

  • region — регион;
  • segment — сегмент;
  • universe — universe.

Responses

Response Schema:
required
object (ObjMeta)

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

required
object

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

Response samples

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