This Python wrapper provides an easy-to-use interface to interact with the IPQualityScore API. It supports various endpoints including proxy and VPN checks, email validation, phone number validation, URL validation, file scanning for malware, darknet data checks, fraud reporting, and account usage information.
API DOCS: Fraud Prevention API | IPQS Fraud Detection API Documentation | IPQualityScore
You can switch between English and Russian documentation using the links below:
The ipqsapi library provides an easy-to-use interface for interacting with the IPQualityScore API. The library includes methods for checking proxy/VPN usage, phone numbers, email addresses, URLs, malware, darknet data, and reporting fraud.
To install the library, use pip:
pip install ipqsapi
Here's a brief overview of how to use the ipqsapi library with various endpoints:
First, you need to initialize the API with your IPQualityScore API key:
import ipqsapi
api = ipqsapi.API("YOUR_API_KEY_HERE")
To check if an IP address is a proxy or VPN, use the proxyvpn_check endpoint:
from ipqsapi.data.proxyvpn_data import ProxyVPNData
proxy_vpn = api.proxyvpn_check
response: ProxyVPNData = proxy_vpn.get_info(
ip_address="23.106.56.43",
user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0",
user_language="en-US",
allow_public_access_points=True,
mobile=True,
fast=True,
strictness=0,
lighter_penalties=False
)
print(response)
To validate a phone number, use the phone_check endpoint:
from ipqsapi.data.phone_data import PhoneData
phone = api.phone_check
response: PhoneData = phone.get_info(
phone_number="15172938623",
country="US",
strictness=1
)
print(response)
To validate an email address, use the email_check endpoint:
from ipqsapi.data.email_data import EmailData
email = api.email_check
response: EmailData = email.get_info(
email="sawaglumov2006@gmail.com",
fast=True,
timeout=5,
strictness=1
)
print(response)
To check a URL, use the url_check endpoint:
from ipqsapi.data.url_data import UrlData
url = api.url_check
response: UrlData = url.get_info(
url="google.com",
fast=True,
timeout=5,
strictness=1
)
print(response)
To scan a file for malware or check a file's previous scan result, use the malicious_check endpoint:
https://drive.usercontent.google.com/download?id=1a8n_HxT7QYw-8YOOCH0BnNKQQqdpB4HE&export=download&authuser=0&confirm=t&uuid=1883796e-6f0b-4fc2-b784-ce0f94da9291&at=APZUnTV_A-yM1WjkP04-9qjMynwb:1721654626905from ipqsapi.data.malicious_data import MaliciousData
malicious = api.malicious_check
response: MaliciousData = malicious.get_info(
file_path_or_url="file.py",
is_url=False
)
print(response)
# For URL-based file checks
malicious = api.malicious_check
response: MaliciousData = malicious.get_info(
file_path_or_url="https://drive.usercontent.google.com/download?id=1a8n_HxT7QYw-8YOOCH0BnNKQQqdpB4HE&export=download&authuser=0&confirm=t&uuid=1883796e-6f0b-4fc2-b784-ce0f94da9291&at=APZUnTV_A-yM1WjkP04-9qjMynwb:1721654626905",
is_url=True
)
print(response)
To check if data has appeared in a darknet leak, use the darknet_check endpoint:
from ipqsapi.data.darknet_data import DarknetData
darknet = api.darknet_check
response: DarknetData = darknet.get_info(
data="SawaPlayGO",
type="username"
)
print(response)
To report fraudulent data, use the fraud_send endpoint:
from ipqsapi.data.fraud_data import FraudData
fraud = api.fraud_send
response: FraudData = fraud.send_info(
ip="23.106.56.43"
)
print(response)
To get account usage information, use the account_check endpoint:
from ipqsapi.data.account_data import AccountData
account = api.account_check
response: AccountData = account.get_info()
print(response)
Replace "YOUR_API_KEY_HERE" with your actual IPQualityScore API key. You can obtain your API key from the IPQualityScore website.
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to submit issues or pull requests. We welcome contributions from the community.
Библиотека ipqsapi предоставляет удобный интерфейс для взаимодействия с API IPQualityScore. Библиотека включает методы для проверки использования прокси/VPN, телефонных номеров, email-адресов, URL, вредоносного ПО, данных из Даркнета и отчетов о мошенничестве.
Для установки библиотеки используйте pip:
pip install ipqsapi
Вот краткий обзор использования библиотеки ipqsapi с различными конечными точками:
Сначала нужно инициализировать API с вашим ключом API IPQualityScore:
import ipqsapi
api = ipqsapi.API("ВАШ_API_КЛЮЧ")
Для проверки, является ли IP-адрес прокси или VPN, используйте конечную точку proxyvpn_check:
from ipqsapi.data.proxyvpn_data import ProxyVPNData
proxy_vpn = api.proxyvpn_check
response: ProxyVPNData = proxy_vpn.get_info(
ip_address="23.106.56.43",
user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0",
user_language="ru-RU",
allow_public_access_points=True,
mobile=True,
fast=True,
strictness=0,
lighter_penalties=False
)
print(response)
Для проверки телефонного номера используйте конечную точку phone_check:
from ipqsapi.data.phone_data import PhoneData
phone = api.phone_check
response: PhoneData = phone.get_info(
phone_number="15172938623",
country="US",
strictness=1
)
print(response)
Для проверки email-адреса используйте конечную точку email_check:
from ipqsapi.data.email_data import EmailData
email = api.email_check
response: EmailData = email.get_info(
email="sawaglumov2006@gmail.com",
fast=True,
timeout=5,
strictness=1
)
print(response)
Для проверки URL используйте конечную точку url_check:
from ipqsapi.data.url_data import UrlData
url = api.url_check
response: UrlData = url.get_info(
url="google.com",
fast=True,
timeout=5,
strictness=1
)
print(response)
Для сканирования файла на наличие вредоносного ПО или проверки предыдущего сканирования файла используйте конечную точку malicious_check:
from ipqsapi.data.malicious_data import MaliciousData
# Локальный файл
malicious = api.malicious_check
response: MaliciousData = malicious.get_info(
file_path_or_url="file.py",
is_url=False
)
print(response)
# Проверка файла по URL
malicious = api.malicious_check
response: MaliciousData = malicious.get_info(
file_path_or_url="https://drive.usercontent.google.com/download?id=1a8n_HxT7QYw-8YOOCH0BnNKQQqdpB4HE&export=download&authuser=0&confirm=t&uuid=1883796e-6f0b-4fc2-b784-ce0f94da9291&at=APZUnTV_A-yM1WjkP04-9qjMynwb:1721654626905",
is_url=True
)
print(response)
Для проверки, появились ли данные в утечке из Даркнета, используйте конечную точку darknet_check:
from ipqsapi.data.darknet_data import DarknetData
darknet = api.darknet_check
response: DarknetData = darknet.get_info(
data="SawaPlayGO",
type="username"
)
print(response)
Для сообщения о мошенничестве используйте конечную точку fraud_send:
from ipqsapi.data.fraud_data import FraudData
fraud = api.fraud_send
response: FraudData = fraud.send_info(
ip="23.106.56.43"
)
print(response)
Для получения информации о использовании аккаунта используйте конечную точку account_check:
from ipqsapi.data.account_data import AccountData
account = api.account_check
response: AccountData = account.get_info()
print(response)
Замените "ВАШ_API_КЛЮЧ" на ваш реальный ключ API IPQualityScore. Вы можете получить ваш API ключ на веб-сайте IPQualityScore.
Этот проект лицензируется под лицензией MIT - смотрите файл LICENSE для деталей.
Не стесняйтесь сообщать об ошибках или отправлять pull-запросы. Мы приветствуем вклад от сообщества.
FAQs
API wrapper - www.ipqualityscore.com
We found that ipqsapi demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.