Device Fingerprint Stats & Averages API Documentation

Third party services and your own platform can access average fraud rates, total devices, and total page views based on the optional custom variables that are passed such as "userID", "transactionID", etc. This API makes it easy to retrieve average fraud rates so your platform can perform the necessarily business logic to mitigate any potential risk.

General Notes:

Any custom tracking variable established in your account's custom tracking variables that is passed in the "Startup.Store()" function can be searched by simply being attached to the API request such as "userID" in the example below.
The "country" variable is accepted in the 2 letter country code format.
"start_date" and "end_date" are accepted in "YYYY-mm-dd" format.

<?php
// Set the API Key.
$key = 'YOUR_API_KEY_HERE';

// We have a user ID we'd like to get averages for.
$user = 1234;

// We have a country for this user.
$country = 'US';

// Our device tracker ID.
$id = 4321;

// Create parameters array.
$parameters = array(
	'userID' => $user,
	'country' => $country
);

// Format our parameters.
$formatted_parameters = http_build_query($parameters);

// Create our API URL.
$url = sprintf(
	'https://www.ipqualityscore.com/api/json/%s/%s/tracker/average?%s', 
	$key,
	$id, 
	$formatted_parameters
);

// Fetch JSON API result.
$json = file_get_contents($url);

// Decode the result.
$result = json_decode($json, true);

// If request was successful.
if(isset($result['success']) && $result['success'] === true){
	echo $result['fraud_average'];
} else {
	echo '0.00';
}
?>

# THIS SHOULD NEVER BE USED IN PRODUCTION AS IS!

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

from http.server import BaseHTTPRequestHandler, HTTPServer
import json
import requests

hostName = "localhost"
serverPort = 8080

class IPQS:
    key = "YOUR_API_KEY_HERE"

    def averages_api(self, vars: dict = {}) -> dict:
        """Method used to lookup Stats & Averages API 

        Args:
            vars (dict, optional): Reffer to https://www.ipqualityscore.com/documentation/device-fingerprint-api/averages for variables. 
                                    You would add your custom tracking variables here as well

        Returns:
            dict: Returns json response in an array.
        """
        url = "https://www.ipqualityscore.com/api/%s/tracker/average" % (self.key)
        if bool(vars):
            x = requests.get(url, params = vars)
        else:   
            x = requests.get(url)
        return (json.loads(x.text))




class MyServer(BaseHTTPRequestHandler):
    """This is an example basic web server. we limited it to handle "/" path only."""

    def do_GET(self):
        if self.path == "/":
            self.send_response(200)
            self.send_header("Content-type", "text/html")
            self.end_headers()
            self.wfile.write(bytes("<body>", "utf-8"))
            ipqs = IPQS()
            
            #Example using a custom Tracking such as UserID 
            #print(ipqs.averages_api({'UserID':1}))

            print(ipqs.averages_api())
            self.wfile.write(bytes("<p>This is an example do not simply copy paste.</p>", "utf-8"))
            self.wfile.write(bytes("</body>
<!-- Mirrored from www.ipqualityscore.com/documentation/device-fingerprint-api/averages by HTTrack Website Copier/3.x [XR&CO'2014], Mon, 06 May 2024 09:42:20 GMT -->
</html>", "utf-8"))

if __name__ == "__main__":        
    webServer = HTTPServer((hostName, serverPort), MyServer)
    print("Server started http://%s:%s" % (hostName, serverPort))

    try:
        webServer.serve_forever()
    except KeyboardInterrupt:
        pass

    webServer.server_close()
    print("Server stopped.")