Геокодирование /geocode

Поиск стран, объектов административно-территориального деления, городов, улиц, адресов и точек интереса по словам из названия, а также обратное геокодирование.

Схема запроса

https://api.visicom.ua/data-api/5.0/[lang]/geocode[.format]?[categories|ci][&text|t][&word_text|wt][&near|n|intersect|i|contains|co][&radius|r][&limit|l][&country|c][&boost_country|bc][&zoom][&key][&callback]

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

ПараметрОписание
langЯзык запроса и ответа. Один из (ru, uk, en).
formatФормат возвращаемых данных (json, csv).
categories|ciСписок идентификаторов категорий через «,» в которых будет выполняться поиск объектов.
categories_exclude|ceСписок идентификаторов категорий через «,» которые будут исключены из результатов поиска.
text|tТекст, который должен встречаться в описании объекта. Пример: text=Крещатик, t=Жовтень.
word_text|wtСлова, которые должны встречаться в описании объекта. Пример: word_text=Киев. В поиск не попадут Киевский, Киевская и т.д.
near|nИдентификатор объекта или геометрия в формате WKT с количеством вершин не более 250. Для точек возможна упрощенная запись в виде lng,lat. Расстояние до указанной геометрии будет учитываться при формировании результата. Пример: near=POIA1KIGKN, n=30.5113,50.4550.
radius|rРадиус в метрах вокруг местоположения, которое задано параметром near.
orderПараметр указывает тип сортировки объектов в ответе. Может принимать значения relevance (сортировка по релевантности объектов для данного запроса), distance (сортировка по удаленности от точки, указанной параметром near). По умолчанию - значение relevance.
intersect|iИдентификатор объекта или геометрия в формате WKT с количеством вершин не более 250. Для точек возможна упрощенная запись в виде lng,lat. Запрос возвращает объекты, геометрия которых пересекается с геометрией, описанной данным параметром.
contains|coИдентификатор объекта или геометрия в формате WKT с количеством вершин не более 250. Для точек возможна упрощенная запись в виде lng,lat. Запрос возвращает объекты, геометрия которых находится внутри геометрии, описанной данным параметром.
zoom|zМасштаб карты по спецификации TMS. Чем меньше масштаб, тем меньше учитываются координаты, указанные параметром near при расчете релевантности объектов.
limit|lМаксимальное количество возвращаемых объектов. Максимум 250.
country|cКод страны.
boost_country|bcКод страны. Если не указан параметр country, то объекты в указанной этим параметром стране имеют больший приоритет.
keyКлюч авторизации.
callbackИмя функции для JSONP запроса к серверу.

Взаимоисключающие параметры

  • near, intersect, contains
  • text, word_text
  • categories, categories_exclude

Этот запрос не возвращает полную геометрию объектов. В ответе есть только гео-центроид (geo_centroid) и ограничивающая рамка (bbox). Для получения полного описания и геометрии объекта используйте запрос /feature

Ответ на запрос

Структура ответа на запрос /geocode зависит от категории объекта (список категорий). Схемы ответа в зависимости от categories можно посмотреть перейдя по ссылкам:

Пример

Получить все улицы Киева, в имени которых есть слово «Заплавная»:

https://api.visicom.ua/data-api/5.0/ru/geocode.json?categories=adr_street&text=Киев, Заплавная&key=YOUR_API_KEY

Найти адрес «г. Киев, ул. Крещатик, 26»:

https://api.visicom.ua/data-api/5.0/ru/geocode.json?text=г. Киев, ул. Крещатик, 26&key=YOUR_API_KEY

Получить все рестораны в радиусе 300 метров от компании Визиком:

https://api.visicom.ua/data-api/5.0/ru/geocode.json?categories=poi_restaurant&near=POIA1KIGKN&radius=300&key=YOUR_API_KEY

Найти ближайший адрес в радиусе 50 м от заданной точки:

https://api.visicom.ua/data-api/5.0/ru/geocode.json?categories=adr_address&near=30.51043,50.45358&r=50&l=1&key=YOUR_API_KEY