Пошук
API геолокації IP
API геолокації IP Cleariflow — швидкий, ефективний, сучасний RESTful JSON API, який визначає місцезнаходження та інші деталі IP-адрес у понад 190 країнах.
GET
API геолокації IP
API працює надзвичайно просто: передайте API-ключ разом із IP-адресою — і ви отримаєте повні дані про місцезнаходження, включаючи поштові індекси, назви міст, регіональну інформацію, дані про країну та точні координати широти/довготи.
Це успішний запит — нижче повертаються IP-адреса та пов’язані дані:
Відповідь виглядатиме так:
Цього достатньо, щоб отримати геолокацію та інші дані відвідувача! Єдиний обов’язковий параметр — ваш унікальний API-ключ.
Початок роботи
REST-архітектура
Як і всі API Cleariflow, API геолокації IP дотримується принципів REST. Воно використовує передбачувані URL, орієнтовані на ресурси, та HTTP-коди статусу для позначення помилок.Безпека HTTPS
Усі з’єднання з API геолокації IP мають бути захищені протоколами TLS 1.2 або вище.Версіонування API
Усі API Cleariflow мають версії. API геолокації IP наразі працює у версії 1.Автентифікація за API-ключем
API-ключ є унікальним обліковим даним для доступу до API геолокації IP Cleariflow. Важливо: кожен API Cleariflow потребує окремого ключа, тому для різних сервісів, як-от геолокація IP і перевірка email, потрібні різні ключі. Для автентифікації запитів додайте API-ключ до базового URL.Базовий URL
Ендпоінт геолокації
API геолокації IP Cleariflow потребує лише вашого унікального API-ключа і автоматично визначає IP-адресу клієнта, що надсилає запит. Альтернативно можна передати параметр «ip_address», щоб вказати конкретну IP для аналізу:Параметри запиту
Ваш унікальний API-ключ. Зверніть увагу: у кожного користувача є унікальні API-ключі для кожного API Cleariflow, тому ключ IP Geolocation не працюватиме для Email Validation API, наприклад.
IP-адреса для геолокації. Підтримуються адреси IPv4 і IPv6. Якщо параметр не вказано, сервіс геолокує IP-адресу, з якої надійшов запит.
Список верхньорівневих ключів через кому (наприклад,
?fields=country,security). Для VPN/proxy використовуйте security — повертається весь об’єкт (is_vpn, is_proxy і vpn_provider, якщо є). Вкладені ключі на кшталт лише is_vpn не підтримуються.Параметри відповіді
Відповідь API повертається у універсальному та легкому форматі JSON.IP-адреса, передана для геолокації.
Назва міста.
Geoname ID міста.
Штат або провінція, де знаходиться місто.
ISO 3166-2 код штату або провінції.
Geoname ID штату або провінції.
ZIP або поштовий індекс.
Назва країни.
ISO 3166-1 alpha-2 код країни.
Geoname ID країни.
true, якщо країна в ЄС, false — якщо ні.
Назва континенту.
Дволітерний код континенту: AF, AS, EU, NA, OC, SA, AN.
Geoname ID континенту.
Довгота у десятковому форматі.
Широта у десятковому форматі.
true, коли IP відповідає базі VPN exit-node (IP-to-VPN MMDB).true, коли IP відповідає базі proxy (IP-to-VPN MMDB).Назва VPN-сервісу з MMDB (наприклад,
NordVPN). Пропускається, коли is_vpn — false.Назва часового поясу з IANA Time Zone Database.
Абревіатура часового поясу з IANA Time Zone Database.
Зміщення часового поясу від Greenwich Mean Time (GMT).
Поточний час у локальному часовому поясі.
true, якщо локація наразі в літньому часі (DST).
Посилання на розміщений прапор країни у форматі SVG.
Посилання на розміщений прапор країни у форматі PNG.
Прапор країни у вигляді emoji.
Прапор країни в unicode.
Назва валюти.
Код валюти у форматі ISO 4217.
Визначається з назви ASN-організації (наприклад, Cellular, Cable/DSL, Corporate, Cloud, Hosting). VPN і proxy повідомляються в
security, а не тут.Номер автономної системи.
Назва організації автономної системи.
Назва інтернет-провайдера (ISP).
Назва організації.
Обмеження полів відповіді
Можна отримати лише кілька полів з JSON-відповіді. Для цього передайте параметр fields зі списком верхньорівневих ключів через кому. Наприклад, запит лише на країну та місто IP виглядатиме так:Сценарії використання
Геолокація відвідувача сайту
Щоб отримати геолокацію за IP-адресою, просто передайте унікальний API-ключ у шаблоні нижче. Зверніть увагу: для запиту не потрібно знати IP відвідувача.Коди відповідей і помилок
Якщо запит не вдається, помилка також повертається у форматі JSON з кодом і описом, детально наведеними нижче.Коди країн
Нижче наведено список дволітерних ISO 3166 Alpha 2 кодів країн, що використовуються у відповіді. Переглянути список у CSV.Інші примітки
Важлива інформація про тарифікацію: кожна оброблена IP-адреса списує один кредит. Тарифікація відбувається за запит, незалежно від успішності відповіді. Тому навіть передача недійсної IP-адреси на кшталт «fda3346ds» все одно списує один кредит.API геолокації IP