Getting Started

About the Request List API

The Request List API allows you to retrieve previous Proxy Detection API, Email Verification API, Device Fingerprinting, Malicious URL Scanner API, Malware File Scanner API, and Dark Web Leak API technology requests to our API based on the date they occurred or custom variables.

Request Formatting

You can retrieve the results of previous requests to our API in bulk for additional external processing. Requests via this API can be made via POST or GET.

You can pass custom tracking variables (such as userID and transactionID) established in your account settings with each API request. This allows our reporting tools to filter by specific variables such as users, products, campaigns, and transactions so you can easily match up records with your system to identify fraudulent activity.

All requests to this API must contain a type parameter corresponding to the original request's type (proxy, email, devicetracker, mobiletracker, url , malware_scan , leaked_email , leaked_username , or leaked_password ).

Example Requests

Requesting a Date Range

The following example request shows how to request a date range from the API:

Note

start_date is optional. If omitted, it defaults to one week ago.

https://www.ipqualityscore.com/api/json/requests/YOUR_API_KEY_HERE/list?type=proxy&start_date=2020-01-01&stop_date=2020-01-31

Using a Custom Variable

Assume you want to find a request with a transactionID of 99. The following example shows how to retrieve all requests with a transactionID of 99.

Note

type is required. See Accepted Parameters for acceptable values.

https://www.ipqualityscore.com/api/json/requests/YOUR_API_KEY_HERE/list?transactionID=99&type=proxy

Response Example

This is an example success response in JSON format. Responses are also available in XML format. Details about each of these variables can be found in Response Parameters.

{
	"success": true,
	"requests": [{
		"ASN": "15169",
		"ISP": "Google",
		"country_code": "US",
		"region": "California",
		"city": "Mountain View",
		"organization": "Google",
		"latitude": 37.41,
		"longitude": -122.08,
		"is_crawler": false,
		"timezone": "America/Chicago",
		"mobile": false,
		"host": "dns.google",
		"proxy": true,
		"vpn": true,
		"tor": false,
		"recent_abuse": true,
		"bot_status": true,
		"success": true,
		"message": "Success",
		"fraud_score": 100,
		"transaction_details": [],
		"request_id": "4JAer3sX6rH3Xl"
	}],
	"current_page": 1,
	"total_pages": 1,
	"request_count": 1,
	"max_records_per_page": 25,
	"total_records": 1,
	"request_id": "4JAer3sX6rH3bk"
}

Next Steps

Tailor your API requests to match your specific needs with advanced options. Or learn more about each of the variables included in the responses you receive.

// You API Key.
$key = 'YOUR_API_KEY_HERE';

// The original request type
// possible values: "proxy", "devicetracker", "email", or "mobiletracker"
$type = 'proxy';
	
// The date we're looking for records from.
$start_date = '2020-01-01';

// Optional IP address
$ip_address = '8.8.8.8';

// Optional Device ID (device fingerprinting only)
$device_id = 'T3G4fy07D82564i8hYNo2t83TpC84y5d1M3OKN4502U6ObDk8U3987KlRxn75prz'

// Base URL
$url = 'https://www.ipqualityscore.com/api/json/requests/%s/list?%s';
	
// Parameters
$parameters = array(
	'type' => $type,
	'start_date' => $start_date,
	'device_id' => $device_id,
	'ip_address' => $ip_address
);

// Build our query.
$query = http_build_query($parameters);

// Finish assembling the URL and make the request.
$json = file_get_contents(sprintf($url, $key, $query));
	
// Exit and print the response.
exit(print_r(json_decode($json, true)));

import json
import requests

# You may need to install Requests pip
# python -m pip install requests

class IPQS:
    key = "YOUR_API_KEY_HERE"
    def request_list_api(self, vars: dict = {}) -> dict:
        url = 'https://www.ipqualityscore.com/api/json/requests/%s/list' % (self.key)
        x = requests.get(url, params = vars)

        return (json.loads(x.text))

if __name__ == "__main__":

    # The original request type
    # possible values: "proxy", "devicetracker", "email", or "mobiletracker"
    type = 'proxy'
        
    # The date we're looking for records from.
    start_date = '2020-01-01'

    # Optional IP address
    ip_address = '8.8.8.8'

    # Optional Device ID (device fingerprinting only)
    device_id = 'T3G4fy07D82564i8hYNo2t83TpC84y5d1M3OKN4502U6ObDk8U3987KlRxn75prz'

    # Base URL
    url = 'https://www.ipqualityscore.com/api/json/requests/%s/list?%s'
        
    # Parameters
    parameters = {
        'type' : type,
        'start_date' : start_date,
        'device_id' : device_id,
        'ip_address' : ip_address
    }

    print((IPQS()).request_list_api(parameters))

Ready to eliminate fraud?

Start fighting fraud now with 1,000 Free Lookups!

We're happy to answer any questions or concerns.

Chat with our fraud detection experts any day of the week.

Call us at: (800) 713-2618

Schedule a Demo Sign Up