API Reference
/
Security API

Fingerprinting API (1.0.1)

Documentation for fingerprinting-api.com. These APIs allow you to secure your website or application against scraping, bots, attacks and other various threats and understand your users behaviors in a cookieless world.

Authentication

This API uses an API key for authentication. To interact with the API, you will need to provide your API key in the x-api-key header of your requests. 2. Include your API key in the request headers as x-api-key: YOUR_API_KEY.

Filtering Data

When querying data, you can use the filter_groups parameter to filter results based on specific attributes. The filter_groups object consists of a list of filters defined by the FilerGroupSchema, where each filter is composed of an object, field, operator, and value. This allows for flexible filtering across various dimensions like country, city, browser, or page.

AND and OR Filters: To apply an AND condition (e.g., filter by both A and B), include both filters in the same filters list within a single filter group. To apply an OR condition (e.g., filter by either A or B), place each filter in separate filter_groups. Each filter group operates independently, so results will match any group that evaluates as true.

If you want to filter data to only see visitors from a specific city using a specific browser (AND condition), your filter might look like this:

{
  "filter_groups": [
    {
      "filters": [
        { "object": "city", "field": "name", "operator": "contains", "value": "New York" },
        { "object": "browser", "field": "name", "operator": "is_any_of", "value": ["Chrome"] }
      ]
    }
  ]
}

If you want to filter data for either visitors from a specific city OR visitors using a specific browser (OR condition), you would structure the filter like this:

{
  "filter_groups": [
    {
      "filters": [
        { "object": "city", "field": "name", "operator": "contains", "value": "New York" }
      ]
    },
    {
      "filters": [
        { "object": "browser", "field": "name", "operator": "contains", "value": "Chrome" }
      ]
    }
  ]
}
Download OpenAPI description
index.json
index.yaml
Overview
Support Team support@fingerprinting-api.com
Languages
Servers
Mock server
https://doc.fingerprinting-api.com/_mock/apis/
https://api.fingerprinting-api.com/

Marketing API

Operations

Security API

Operations

Get Visitor Adblock Status

Request

Query
visitor_idstring(Visitor Id)required
curl -i -X GET \
  'https://doc.fingerprinting-api.com/_mock/apis/security/adblock-status/visitor_id?visitor_id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
adblockAdblock (boolean) or Adblock (string)(Adblock)
Default "Unknown"
Any of:
boolean(Adblock)
Default "Unknown"
adblock_extensionstring(Adblock Extension)required
visitor_idstring(Visitor Id)required
Response
application/json
{
  "adblock": "Unknown",
  "adblock_extension": "string",
  "visitor_id": "string"
}

Get Visitor Bot Status

Request

Query
visitor_idstring(Visitor Id)required
curl -i -X GET \
  'https://doc.fingerprinting-api.com/_mock/apis/security/bot-status/visitor_id?visitor_id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
is_abuserIs Abuser (boolean) or Is Abuser (string)(Is Abuser)
Default "Unknown"
Any of:
boolean(Is Abuser)
Default "Unknown"
is_attackerIs Attacker (boolean) or Is Attacker (string)(Is Attacker)
Default "Unknown"
Any of:
boolean(Is Attacker)
Default "Unknown"
is_proxyIs Proxy (boolean) or Is Proxy (string)(Is Proxy)
Default "Unknown"
Any of:
boolean(Is Proxy)
Default "Unknown"
is_threatIs Threat (boolean) or Is Threat (string)(Is Threat)
Default "Unknown"
Any of:
boolean(Is Threat)
Default "Unknown"
visitor_idstring(Visitor Id)required
Response
application/json
{
  "is_abuser": "Unknown",
  "is_attacker": "Unknown",
  "is_proxy": "Unknown",
  "is_threat": "Unknown",
  "visitor_id": "string"
}

Get Visitor Scraping Status

Request

Query
visitor_idstring(Visitor Id)required
curl -i -X GET \
  'https://doc.fingerprinting-api.com/_mock/apis/security/scraping-status/visitor_id?visitor_id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
scorenumber(Score)required
visitor_idstring(Visitor Id)required
visitor_typestring(VisitorType)

An enumeration.

Default "HUMAN"
Enum"HUMAN""SCRAPER""BOT""OTHER""UNKNOWN"
Response
application/json
{
  "score": 0,
  "visitor_id": "string",
  "visitor_type": "HUMAN"
}

Get Visitor VPN Status

Request

Query
visitor_idstring(Visitor Id)required
curl -i -X GET \
  'https://doc.fingerprinting-api.com/_mock/apis/security/vpn-status/visitor_id?visitor_id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
visitor_idstring(Visitor Id)required
vpnVpn (boolean) or Vpn (string)(Vpn)
Default "Unknown"
Any of:
boolean(Vpn)
Default "Unknown"
Response
application/json
{
  "visitor_id": "string",
  "vpn": "Unknown"
}

Get Visitor Scraping Extensions Status

Request

Path
visitor_idstring(Visitor Id)required
curl -i -X GET \
  'https://doc.fingerprinting-api.com/_mock/apis/security/scraping-extensions-status/{visitor_id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successful Response

Bodyapplication/json
adblockAdblock (boolean) or Adblock (string)(Adblock)
Default "Unknown"
Any of:
boolean(Adblock)
Default "Unknown"
scraper_extension_listArray of strings(Scraper Extension List)
Default []
visitor_idstring(Visitor Id)required
Response
application/json
{
  "adblock": "Unknown",
  "scraper_extension_list": [],
  "visitor_id": "string"
}

User API

Operations