Regions API

Regions API используется для выбора региона, в границах которого выполняется поиск организаций, зданий и мест.

Регионом (region_id) в рамках Поисковых API называется агломерация, включающая крупный город и ближайшие населённые пункты, а также города-спутники. Это территории с повышенной детализацией карты и подробным набором данных и атрибутов справочника. Территории за границами региона — населенные пункты, область в целом, край, республика и т. д. — называются сегментами (segment_id).

Обратите внимание, что регионы и сегменты отвечают только внутреннему формату хранения данных в 2ГИС и в общем случае никак не связаны с субъектами Российской Федерации.

Этот API предназначен в основном для внутреннего использования.

Для работы с местами и компаниями за границами регионов используется поиск с геоограничениями.

Формат запроса

В данном разделе приведён пример запроса

https://catalog.api.2gis.com/2.0/region/search?q=Москва&key=YOUR_KEY

В запросе используются следующие параметры:

q=Москва — поиск выполняется по запросу «Москва»;
key=YOUR_KEY — ваш ключ API.

Формат ответа на запрос

Ответ на запрос возвращается в формате JSON:

{
    "meta": {
        "api_version": "2.0.448950",
        "code": 200,
        "issue_date": "20200629"
    },
    "result": {
        "items": [
            {
                "id": "32",
                "name": "Москва",
                "type": "region"
            }
        ],
        "total": 1
    }
}

Как использовать

Ниже представлен пример работы с Regions API.

Определение области поиска из пользовательского запроса «Москва»:

https://catalog.api.2gis.com/2.0/region/search?q=Москва&key=YOUR_KEY

Поиск категории с указанием области поиска:

https://catalog.api.2gis.com/2.0/catalog/rubric/search?q=кафе&region_id=32&key=YOUR_KEY

Поиск филиалов в найденной рубрике:

https://catalog.api.2gis.com/3.0/items?rubric_id=162&sort_point=37.622161%2C55.751597&key=YOUR_KEY

Начало работы

Получите ключ доступа:
1. Зарегистрируйтесь в личном кабинете Platform Manager.
2. Создайте демо-ключ или купите ключ для доступа к API: см. инструкцию Ключи доступа.
Работать с ключами можно в личном кабинете Platform Manager: подробнее см. в разделе Platform Manager.
Изучите формат запроса и формат ответа.
Изучите примеры запросов к Regions API.