IPQS Request List API allows you to retrieve previous Proxy Detection API, Email Validation API and Device Fingerprinting technology requests to our API based on the date they occurred or custom variables.
You may want to 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. For the purposes of our documentation we'll demonstrate GET requests. Custom tracking variables passed with your initial request must be listed on your account's custom tracking variables in order for the request to be successful. All requests to this API must contain a "type" parameter corresponding to the original request's type ("proxy", "email", "devicetracker", or "mobiletracker").
You can request a date range from our API like such:
Let's say we knew that the request had a "transactionID" of 99. Here's how we'd request to see all requests with a transaction ID of 99. (Note: type is required, see the table below for acceptable values):
NOTE: The structure of each request will vary based on the type specified. For more details about what format to expect for your query type, please refer to: Proxy Detection API, Email Validation API or Device Fingerprinting technology
Due to the nature of platform requirements or frameworks it may be necessary to request IPQS API endpoints without passing the API key in the URL. As an alternative, IPQS allows the API key to be passed via GET, POST, or Headers. These requests use the following endpoints:
|Header||IPQS-KEY (Additional parameters passed as either GET or POST)||IPQS-KEY: YOUR_API_KEY_HERE|
Below is a list of accepted parameters, a brief description and a listing of their required formatting.
|Parameter Name||Expected Values||Description||Update Example|
|type||String ("proxy", "email", "phone", "devicetracker", or "mobiletracker")||Required||type=proxy|
|page||Integer (1+)||The page number you are requesting. Defaults to 1 if not specified. Used to retrieve more results than the limit provides.||page=2|
|limit||Integer (1 - 250)||Allows you to specify how many results will be returned with your query up to a maximum of 250. Defaults to 25.||limit=100|
|start_date||Date formatted Y-m-d or Y-m-d H:i:s||Fetches records newer than or equal to the date specified.||start_date=2020-01-01|
|stop_date||Date formatted Y-m-d or Y-m-d H:i:s||Fetches records older than or equal to the date specified.||stop_date=2020-01-31|
|tracker_id||Integer (number associated with your tracker in the IPQS device tracker management screen.)||This is an optional parameter used to narrow the scope of a variable lookup for a device tracker type.||tracker_id=233|
|device_id||SHA256 / string||This is an optional parameter to search all matching device ID queries with device fingerprinting.||device_id=323|
|min_fraud_score||Number 0 - 100||This is an optional parameter to limit results to only contain fraud scores greater than or equal to this number.||min_fraud_score=45|
|max_fraud_score||Number 0 - 100||This is an optional parameter to limit results to only contain fraud scores less than or equal to this number.||max_fraud_score=80|
|ip_address||string||This is an optional parameter to search all matching IP address queries for "proxy", "devicetracker", and "mobiletracker" types.||ip_address=188.8.131.52|
|Your custom variables (as defined in account settings):|
|Please login to display your custom variables for this API.|
Below is a list of expected result fields for your query.
|success||Was the request successful?||boolean|
|requests||Array of result objects. (Please refer to: Proxy Detection API, Email Validation API or Device Fingerprinting API)||array of objects|
|current_page||Which page of results was returned by this query.||integer|
|total_pages||Total number of results pages this query produced.||integer|
|request_count||How many results are on this page.||integer|
|max_results_per_page||How many results this response should contain.||integer|
|total_requests||How many results exist in total for this query.||integer|
|request_id||A unique identifier for this request.||String|