Regions API | 2GIS Documentation

Regions API


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

Регионом в рамках этого API называется агломерация, включающая крупный город и ближайшие населённые пункты, а также города-спутники. Регионы в общем случае никак не связаны с субъектами Российской Федерации, и отвечают внутреннему формату хранения данных в 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. Получите ключ. Для этого заполните анкету.
  2. Изучите формат запроса и формат ответа.