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

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

Спецификация OpenAPI
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
Examples:
  • locale=ar_AE - Арабский язык для ОАЭ
  • locale=ru_RU - Русский язык для России

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

Список доступных локалей:

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

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

country_code_filter
Array of strings
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
Array of strings
Default: "region"
Examples:
  • type=region,segment - Пример нескольких типов
  • type=region - Пример единичного типа

Фильтр по типу объекта, перечисляются через запятую.

Список доступных типов:

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

Responses

Response Schema:
required
object

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

required
object

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

Response samples

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