Примеры
Поиск по адресу
Простой поиск по адресу
https://catalog.api.2gis.com/3.0/items/geocode?q=Москва, Никитский переулок, 3&fields=items.point,items.geometry.centroid&key=YOUR_KEY
Для более точного поиска укажите в тексте запроса город (посёлок, район, область), где выполняется поиск. Название населённого пункта рекомендуется указывать вместе с названием области.
Поиск с указанием точки поиска
https://catalog.api.2gis.com/3.0/items/geocode?q=Никитский переулок, 3&fields=items.point,items.geometry.centroid&sort_point=37.62143%2C55.752966&sort=distance&key=YOUR_KEY
При сортировке по возрастанию расстояния (sort = distance
) первыми в результате поиска будут показаны наиболее близкие к точке объекты. Город в тексте запроса можно не указывать.
Поиск с указанием точки поиска и радиуса
https://catalog.api.2gis.com/3.0/items/geocode?q=Никитский переулок, 3&fields=items.point,items.geometry.centroid&point=37.62143%2C55.752966&&radius=1000&key=YOUR_KEY
Город в тексте запроса можно не указывать.
Поиск в прямоугольной области
https://catalog.api.2gis.com/3.0/items/geocode?q=Никитский переулок, 3&fields=items.point,items.geometry.centroid&point1=37.604977%2C55.7604&point2=37.646514%2C55.743983&key=YOUR_KEY
Город в тексте запроса можно не указывать.
Поиск в произвольной области
https://catalog.api.2gis.com/3.0/items/geocode?q=Никитский переулок, 3&fields=items.point,items.geometry.centroid&polygon=POLYGON((37.5930%2055.7667,37.6494%2055.7667,37.6494%2055.7405,37.5930%2055.7405,37.5930%2055.7667))&key=YOUR_KEY
Город в тексте запроса можно не указывать.
Поиск в определённом городе
-
Определите
city_id
, в котором производится поиск, одним из способов ниже:-
Поиск города по точке:
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.62143&lat=55.752966&type=adm_div.city&key=YOUR_KEY
-
Поиск города по названию:
https://catalog.api.2gis.com/3.0/items/geocode?q=Москва&key=YOUR_KEY
-
-
Из тела ответа скопируйте значение из поля
id
(часть до знака "_") и передайте в полеcity_id
при запросе. Город в названии можно не указывать.https://catalog.api.2gis.com/3.0/items/geocode?q=Никитский переулок, 3&fields=items.point,items.geometry.centroid&city_id=4504222397630173&key=YOUR_KEY
Поиск по адресу с указанием подъезда
https://catalog.api.2gis.com/3.0/items/geocode?q=Обыденский 1-й переулок, 12 ст1, 2 подъезд&sort_point=37.62143,55.752966&fields=items.context,items.links.database_entrances&key=YOUR_KEY
Для получения координаты подъезда:
- определить
id
подъезда — взять значение поляitems.context.entrance_id
;
...
items: [
{
"context": {
"entrance_id": "70030076156592791"
},
...
}
...
]
- определить координату подъезда — в блоке
items.links.database_entrances
найти поid
блок с данными о подъезде.
...
"links": {
"database_entrances": [
{
"entity_name": "2 подъезд",
"entity_number": "2",
"geometry": {
...
"points": [
"POINT(37.602988 55.743127)"
],
...
},
"id": "70030076156592791",
...
},
...
]
}
Для доступа к полю items.links.database_entrances
необходимо дополнительное разрешение у ключа.
Поиск по координатам
Простой поиск по координатам
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.621034&lat=55.750994&fields=items.adm_div,items.address&key=YOUR_KEY
Поиск по координатам с указанием радиуса
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.614757&lat=55.755124&radius=50&fields=items.adm_div,items.address&key=YOUR_KEY
Ограничение количества результатов поиска
В точке может быть несколько объектов. Чтобы ограничить количество объектов в результатах поиска, используйте параметры:
page_size
— количество объектов на странице;page
— номер страницы.
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.614757&lat=55.755124&radius=50&fields=items.adm_div,items.address&page_size=1&page=1&key=YOUR_KEY
Поиск с указанием типа объекта
Поиск здания в точке:
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.618947&lat=55.752954&type=building&key=YOUR_KEY
Получение города в точке:
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.613399&lat=55.755143&fields=items.adm_div,items.address&type=adm_div.city&key=YOUR_KEY
Поиск улицы в точке:
https://catalog.api.2gis.com/3.0/items/geocode?lon=37.611915&lat=55.754061&fields=items.adm_div,items.address&type=street&key=YOUR_KEY