Геокодування /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,containstext,word_textcategories,categories_exclude
Цей запит не повертає повну геометрію об'єктів. У відповіді є тільки гео-центр ваги (geo_centroid) і обмежуюча рамка (bbox). Для отримання повного опису і геометрії об'єкта використовуйте запит /feature
Відповідь на запит
Cтруктура відповіді на запит /geocode залежить від категорії об'єкта (список категорій). Схеми відповіді в залежності від categories можна подивитися перейшовши за посиланнями:
- adm_country
- adm_district
- adm_level1
- adm_level2
- adm_level3
- hst_district
- adm_settlement
- adr_address
- adr_street
- roa_road
- pois
Приклад
Отримати всі вулиці міста Києва, в імені яких зустрічається слово «Заплавна»:
https://api.visicom.ua/data-api/5.0/uk/geocode.json?categories=adr_street&text=Київ, заплавна&key=YOUR_API_KEY
Знайти адресу «м. Київ, вул. Хрещатик, 26»:
https://api.visicom.ua/data-api/5.0/uk/geocode.json?text=м. Київ, вул. Хрещатик, 26&key=YOUR_API_KEY
Отримати всі ресторани в радіусі 300 метрів від компанії Візіком:
https://api.visicom.ua/data-api/5.0/uk/geocode.json?categories=poi_restaurant&near=POIA1KIGKN&radius=300&key=YOUR_API_KEY
Знайти найближчу адресу в радіусі 50 м від заданої точки:
https://api.visicom.ua/data-api/5.0/uk/geocode.json?categories=adr_address&near=30.51043,50.45358&r=50&l=1&key=YOUR_API_KEY