Geocoder API
Geocoder API позволяет определять координаты и получать сведения об объекте на карте по его адресу (прямое геокодирование) и наоборот, определять адрес объекта на карте по его координатам (обратное геокодирование).
Запросы осуществляются методом GET, все необходимые параметры передаются в строке запроса. Ответы формируются только в формате JSON.
Изучите также возможности других API поиска и дополните ваши сценарии работы с объектами на карте.
Как это работает
Щёлкните по карте, чтобы узнать адрес.
Если в запросе указать адрес объекта, то Geocoder API вернёт его географические координаты.
И наоборот, если в запросе указать географические координаты объекта, то Geocoder API вернёт его адрес.
Click on the map to see the URL of the API request
Вы также можете поработать с Geocoder API в песочнице внутри личного кабинета (авторизация не требуется).
Виды геокодирования
Прямое геокодирование
Используется для определения координат по названию объекта или его адресу. Например: пользователь указывает адрес, адрес преобразуется в координаты.
Обратное геокодирование
Используется для определения адреса объекта по его координатам. Например: можно выбрать ближайший к точке на карте дом и получить его адрес.
Начало работы
-
Получите ключ доступа:
- Зарегистрируйтесь в личном кабинете Менеджер Платформы.
- Создайте демо-ключ или купите ключ для доступа к API: см. инструкцию Ключи доступа.
Важно
Для получения некоторой информации об объектах требуется дополнительное согласование. Изучите список методов и полей для получения дополнительной информации по запросу.
Работать с ключами можно в Менеджере Платформы: подробнее см. в документации личного кабинета.
-
Изучите формат запроса и формат ответа.
-
Изучите примеры запросов к Geocoder API.
Дополнительная информация по запросу
Получение некоторой информации об объектах доступно только по запросу и за дополнительную плату. Cвяжитесь с отделом продаж 2ГИС, чтобы приобрести доступ к полям ниже.
Поля указываются с помощью параметра fields
.
Список
items.contact_groups
— контакты компании;items.floors
— количество этажей;items.floor_plans
— планы этажей;items.links.database_entrances.apartments_info
— информация о квартирах в доме;items.employees_org_count
— численность сотрудников организации;items.itin
— индивидуальный номер налогоплательщика;items.trade_license
— лицензия филиала;items.fias_code
— код ФИАС улиц и административных территорий;items.address.components.fias_code
— код ФИАС зданий;items.fns_code
— код ФНС административных территорий;items.okato
— код ОКАТО улиц и административных территорий;items.address.components.okato
— код ОКАТО зданий;items.oktmo
— код ОКТМО улиц и административных территорий;items.address.components.oktmo
— код ОКТМО зданий;items.structure_info.material
— данные о материале здания;items.structure_info.apartments_count
— данные о количестве квартир;items.structure_info.porch_count
— данные о количестве подъездов;items.structure_info.floor_type
— тип перекрытий в здании;items.structure_info.gas_type
— тип газоснабжения здания;items.structure_info.year_of_construction
— год постройки здания;items.structure_info.elevators_count
— количество лифтов в здании;items.structure_info.is_in_emergency_state
— факт признания дома аварийным;items.structure_info.project_type
— серия или проект постройки здания;items.structure_info.chs_name
— название объекта культурного наследия;items.structure_info.chs_category
— категория объекта культурного наследия.
Примеры запроса и ответа
Запрос прямого геокодирования и ответ (поиск по адресу)
Пример запроса прямого геокодирования:
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
}
}