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

Получение ID объектов

В зависимости от задачи в некоторые запросы нужно передать ID объекта: города, региона и т. д. Ниже приведены примеры запросов для получения ID различных объектов.

ID станции метро​

Для выполнения запроса ключу необходим доступ к Places API.

Чтобы получить ID станции метро, отправьте GET-запрос к /3.0/items со следующими параметрами:

Пример запроса:

https://catalog.api.2gis.com/3.0/items?q=пушкинская&location=37.630866,55.752256&type=station.metro&key=API_KEY

Пример ответа:

response.json
{
    "meta": {
        "api_version": "3.0.21070",
        "code": 200,
        "issue_date": "20260805"
    },
    "result": {
        "items": [
            {
                "color": "#9B007F",
                "full_name": "Москва, Пушкинская",
                "id": "4504385606388578",
                "name": "Пушкинская",
                "route_type": "metro",
                "subtype": "metro",
                "type": "station"
            }
        ],
        "total": 1
    }
}

Скопируйте ID станции метро из поля result.items.id.

ID территории​

Территории — это площадные объекты: парки, пляжи, базы отдыха, озёра и прочие места.

Чтобы получить ID территории, отправьте GET-запрос к /3.0/items/geocode одним из способов:

  • укажите название территории, например q=ВДНХ Москва:

    https://catalog.api.2gis.com/3.0/items/geocode?q=ВДНХ Москва&type=adm_div.place&key=API_KEY

  • укажите долготу и широту точки, например lon=37.637635&lat=55.826241:

    https://catalog.api.2gis.com/3.0/items/geocode?lon=37.637635&lat=55.826241&type=adm_div.place&key=API_KEY

В запросе укажите type=adm_div.place для поиска объектов с типом «территория».

Пример ответа:

response.json
{
    "meta": {
        "api_version": "3.0.21070",
        "code": 200,
        "issue_date": "20260805"
    },
    "result": {
        "items": [
            {
                "full_name": "Москва, Выставка достижений народного хозяйства",
                "id": "4504286822138302",
                "name": "Выставка достижений народного хозяйства",
                "subtype": "place",
                "type": "adm_div"
            }
        ],
        "total": 1
    }
}

Скопируйте ID территории из поля result.items.id.

ID города​

Чтобы получить ID города, отправьте GET-запрос к /3.0/items/geocode одним из способов:

  • укажите название города, например q=Москва:

    https://catalog.api.2gis.com/3.0/items/geocode?q=Москва&type=adm_div.city&key=API_KEY

  • укажите долготу и широту точки, например lon=37.630866&lat=55.752256:

    https://catalog.api.2gis.com/3.0/items/geocode?lon=37.630866&lat=55.752256&type=adm_div.city&key=API_KEY

В запросе укажите type=adm_div.city для поиска объектов с типом «город».

Пример ответа:

response.json
{
    "meta": {
        "api_version": "3.0.21070",
        "code": 200,
        "issue_date": "20260805"
    },
    "result": {
        "items": [
            {
                "full_name": "Москва",
                "id": "4504222397630173",
                "name": "Москва",
                "subtype": "city",
                "type": "adm_div"
            }
        ],
        "total": 1
    }
}

Скопируйте ID города из поля result.items.id.

ID региона​

Для выполнения запроса ключу необходим доступ к Regions API.

ID регионов не связаны с кодами субъектов РФ.

Чтобы получить ID региона (области, края, республики и т. д.), отправьте GET-запрос к /2.0/region/search и укажите название региона, например q=Москва.

Пример запроса:

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

Пример ответа:

response.json
{
   "meta": {
      "api_version": "2.0.20926",
      "code": 200,
      "issue_date": "20260630"
   },
   "result": {
      "items": [
            {
               "id": "32",
               "name": "Москва",
               "type": "region"
            }
      ],
      "total": 1
   }
}

Скопируйте ID региона из поля result.items.id.