Geocoder API

Geocoder API позволяет определять координаты и получать сведения об объекте на карте по его адресу (прямое геокодирование) и наоборот, определять адрес объекта на карте по его координатам (обратное геокодирование).

Запросы осуществляются методом GET, все необходимые параметры передаются в строке запроса. Ответы формируются только в формате JSON.

---

Как это работает

Щёлкните по карте, чтобы узнать адрес.

Если в запросе указать адрес объекта, то Geocoder API вернёт его географические координаты.

И наоборот, если в запросе указать географические координаты объекта, то Geocoder API вернёт его адрес.

---

Виды геокодирования

Прямое геокодирование

Используется для определения координат по названию объекта или его адресу. Например: пользователь указывает адрес, адрес преобразуется в координаты.

Обратное геокодирование

Используется для определения адреса объекта по его координатам. Например: можно выбрать ближайший к точке на карте дом и получить его адрес.

---

Примеры запроса и ответа

Запрос прямого геокодирования и ответ (поиск по адресу)

Пример запроса прямого геокодирования:

https://catalog.api.2gis.com/3.0/items/geocode?q=Москва, Садовническая, 25&fields=items.point&key=YOUR_KEY

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

• q=Москва, Садовническая, 25 — адрес здания, координаты которого требуется получить;
• key=YOUR_KEY — ваш ключ API.

Ответ включает в себя искомый объект и его координаты.

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

{
    "meta": {
        "api_version": "3.0.426762",
        "code": 200,
        "issue_date": "20200506"
    },
    "result": {
        "items": [
            {
                "address_name": "Садовническая, 25",
                "full_name": "Москва, Садовническая, 25",
                "id": "4504235282713264_byBBk7792J2H4609HHH1twkm2H3I62G4163B3843vgfpq72C45J4I1JJ2IH8d4ukD178B744355374H2HJJHGJ268",
                "name": "Садовническая, 25",
                "point": {
                    "lat": 55.746397,
                    "lon": 37.634369
                },
                "purpose_name": "Жилой дом с административными помещениями",
                "type": "building"
            }
        ],
        "total": 1
    }
}

Запрос обратного геокодирования и ответ (поиск по координатам)

Пример запроса обратного геокодирования:

https://catalog.api.2gis.com/3.0/items/geocode?lat=55.751508&lon=37.615666&fields=items.point&key=YOUR_KEY

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

• lat=55.75150 — широта точки;
• lon=37.615666 — долгота точки;
• key=YOUR_KEY — ваш ключ API.

Ответ включает в себя объект в точке и его координаты.

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

{
    "meta": {
        "api_version": "3.0.427735",
        "code": 200,
        "issue_date": "20200506"
    },
    "result": {
        "items": [
            {
                "address_name": "Кремль, 1х",
                "building_name": "Государственный Кремлёвский Дворец",
                "full_name": "Москва, Государственный Кремлёвский Дворец",
                "id": "4504235282815753_mA8z1A239J66052JH1HHs43phH3I63G74BHB26A5ogfpq7473CJ1I0JJI5AGps16E17941372854H0H2HJJH24d",
                "name": "Государственный Кремлёвский Дворец",
                "point": {
                    "lat": 55.75142,
                    "lon": 37.615606
                },
                "purpose_name": "Культурное учреждение",
                "type": "building"
            }
        ],
        "total": 1
    }
}

---

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

1. Получите ключ. Для этого заполните анкету.
2. Изучите формат запроса и формат ответа.
3. Изучите примеры запросов к Geocoder API.