Поиск
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 Geolocation и Email Validation нужны разные ключи. Для аутентификации добавьте ключ к базовому URL.Базовый URL
Эндпоинт геолокации
API геолокации IP Cleariflow требует только ваш уникальный API-ключ и автоматически определяет IP-адрес клиента, с которого пришёл запрос. Альтернативно можно передать параметр «ip_address» для анализа конкретного IP:Параметры запроса
Ваш уникальный API-ключ. У каждого пользователя уникальные ключи для каждого API Cleariflow, поэтому ключ IP Geolocation не будет работать, например, с API проверки email.
IP-адрес для геолокации. Поддерживаются IPv4 и IPv6. Если параметр не указан, сервис геолокализирует IP-адрес, с которого был сделан запрос.
Список верхнеуровневых ключей для возврата через запятую (например,
?fields=country,security). Для флагов VPN/прокси используйте security — возвращается весь объект (is_vpn, is_proxy и vpn_provider при наличии). Вложенные ключи вроде только is_vpn не поддерживаются.Параметры ответа
Ответ API возвращается в универсальном лёгком формате JSON.IP-адрес, переданный для геолокации.
Название города.
Geoname ID города.
Штат или провинция, в которой находится город.
ISO 3166-2 код штата или провинции.
Geoname ID штата или провинции.
Почтовый индекс.
Название страны.
ISO 3166-1 alpha-2 код страны.
Geoname ID страны.
true, если страна в ЕС, иначе false.Название континента.
2-буквенный код континента: AF, AS, EU, NA, OC, SA, AN.
Geoname ID континента.
Долгота в десятичном формате.
Широта в десятичном формате.
true, когда IP совпадает с перечисленной базой VPN exit-node (IP-to-VPN MMDB).true, когда IP совпадает с базой прокси (IP-to-VPN MMDB).Название VPN-сервиса из MMDB (например,
NordVPN). Опускается, когда is_vpn равен false.Название часового пояса из базы IANA Time Zone Database.
Аббревиатура часового пояса из базы IANA Time Zone Database.
Смещение часового пояса относительно GMT.
Текущее время в локальном часовом поясе.
true, если в данный момент действует летнее время (DST).Ссылка на размещённый флаг страны в формате SVG.
Ссылка на размещённый флаг страны в формате PNG.
Флаг страны в виде эмодзи.
Флаг страны в unicode.
Название валюты.
Код валюты в формате ISO 4217.
Выводится из названия организации ASN (например, Cellular, Cable/DSL, Corporate, Cloud, Hosting). VPN и прокси указываются в
security, а не здесь.Номер автономной системы.
Название организации автономной системы.
Название интернет-провайдера (ISP).
Название организации.
Ограничение полей ответа
Можно получать только выбранные поля из JSON-ответа. Для этого передайте в query-параметрах fields со списком верхнеуровневых ключей через запятую. Например, запрос только страны и города IP выглядит так:Сценарии использования
Геолокация посетителя сайта
Для запроса геолокации по IP-адресу включите ваш уникальный API-ключ в шаблон ниже. Обратите внимание: знать IP посетителя для запроса не обязательно.Коды ответов и ошибок
При неудачном запросе ошибка также возвращается в JSON с кодом и описанием — подробности ниже.Коды стран
Ниже список двухбуквенных ISO 3166 Alpha 2 кодов стран, используемых в ответе. Список в CSV.Прочее
Важная информация по биллингу: каждый обработанный IP-адрес расходует один кредит. Списание происходит за запрос, независимо от успеха ответа. Поэтому даже передача невалидного IP вроде «fda3346ds» спишет один кредит с аккаунта.API геолокации IP