- About the IPQS APIs
- Proxy & VPN Detection API
- Email Verification API
- Phone Number Validation API
- Malicious URL Scanner API
- Device Fingerprint API
- Mobile Device Fingerprinting SDK
- Gaming Fraud Detection SDK
- Dark Web Leak API
- Malware File Scanner API
- Request List API
- Fraud Reporting API
- Account Management APIs
- Bulk Validation CSV
- Allowlist Blocklist APIs
- Plugins Platforms Integrations
- IP Reputation Database
- IP Address Abuse Feed
- Email Verification Database
-
Custom Integrations
- Getting Started
- Authentication
- Refresh Secret
- IP & Proxy Checks
- Email Verification Checks
- Phone Number Validity Checks
- Device Tracker
- List Device Trackers
- Device Tracker Statistics
- Login Tokens
- Overview Statistics
- Recent Proxy Statistics
- Recent Email Statistics
- Fraud Reporting
- Retrieve Requests by ID
- Country List API Documentation
- Release Notes
Accepted Parameters
| Parameter Name | Description | Expected Values | Update Example |
|---|---|---|---|
| type | Required | String ("proxy", "email", "phone", "devicetracker", "mobiletracker", "url", "malware_scan", "leaked_email", "leaked_username", or "leaked_password") | type=proxy |
| page | The page number you are requesting. Defaults to 1 if not specified. Used to retrieve more results than the limit provides. | Integer (1+) | page=2 |
| limit | Allows you to specify how many results will be returned with your query up to a maximum of 250. Defaults to 25. | Integer (1 - 250) | limit=100 |
| start_date | Fetches records newer than or equal to the date specified. | Date formatted yyyy-mm-dd or yyyy-mm-dd hh-mm-ss | start_date=2020-01-01 |
| stop_date | Fetches records older than or equal to the date specified. | Date formatted yyyy-mm-dd or yyyy-mm-dd hh-mm-ss | stop_date=2020-01-31 |
| tracker_id | This is an optional parameter used to narrow the scope of a variable lookup for a device tracker type. | Integer (number associated with your tracker in the IPQS device tracker management screen.) | tracker_id=555 |
| device_id | This is an optional parameter to search all matching device ID queries with device fingerprinting. | SHA256 / string | device_id=888 |
| min_fraud_score | This is an optional parameter to limit results to only contain fraud scores greater than or equal to this number. | Number 0 - 100 | min_fraud_score=45 |
| max_fraud_score | This is an optional parameter to limit results to only contain fraud scores less than or equal to this number. | Number 0 - 100 | max_fraud_score=80 |
| ip_address | This is an optional parameter to search all matching IP address queries for "proxy", "devicetracker", and "mobiletracker" types. | string | ip_address=8.8.8.8 |
Making Requests Without Passing API Key in URL
Due to the nature of platform requirements or frameworks, you may need to request the Request List API endpoints without passing the API key to the URL. You can alternatively pass the API key via GET, POST, or Headers. These requests use the following endpoints:
JSON
https://ipqualityscore.com/api/json/requests
XML
https://ipqualityscore.com/api/xml/requests
| Method | Value | Example |
|---|---|---|
| GET | key | key=YOUR_API_KEY_HERE&transactionID=99&type=proxy |
| POST | key | key=YOUR_API_KEY_HERE&transactionID=99&type=proxy |
| Header | IPQS-KEY (Additional parameters passed as either GET or POST) | IPQS-KEY: YOUR_API_KEY_HERE |
Reporting Fraud and Improving Machine Learning
Train your account's machine learning algorithms to better identify fraud for your audience. You can use the following endpoint to report precious requests as fraudulent. This data will improve future scoring of requests. Please only report data that is highly likely to be abusive.
Replace PREVIOUS_REQUEST_ID with the email address to report:
https://www.ipqualityscore.com/api/json/report/YOUR_API_KEY_HERE?ip=PREVIOUS_REQUEST_ID
Next Steps
Learn more about each of the variables included in the responses you receive.