Botd API

Security / API Key Intermediate HTTPS CORS
Varies by plan (check documentation)

Overview

Botd is an open-source JavaScript library and API from FingerprintJS that detects whether a web visitor is a bot or a real human browser. It analyzes browser signals in real time and returns a bot detection result that you can verify on your server. It is commonly used to protect login forms, signup flows, and APIs from automated abuse.

Beginner Tip

Include the Botd JavaScript snippet on your page to generate a detection result token, then send that token to your backend and verify it via the API. The client-side library does the heavy lifting — the API just validates the result.

Available Data

Botd data via REST API

Example Response

JSON Response
{
  "title": "The Great Gatsby",
  "authors": [
    "F. Scott Fitzgerald"
  ],
  "publishedDate": "1925-04-10",
  "pageCount": 218,
  "categories": [
    "Fiction"
  ],
  "imageLinks": {
    "thumbnail": "https://books.google.com/..."
  },
  "averageRating": 4
}

Field Reference

requestId Unique identifier for this bot detection request.
bot.result Detection outcome: "notDetected", "good", or "bad".
bot.type Specific bot category detected, such as "headless" or "automation".
ip IP address of the visitor that was analyzed.

Implementation Example

Request
const url = "https://github.com/fingerprintjs/botd";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

401 Unauthorized The API key is missing or incorrect in the request.
Pass your Botd API key in the Auth-Token header or as a query parameter as documented.
Token already used Botd result tokens are single-use and expire quickly.
Always verify the token immediately after the user action — do not cache or re-use tokens.
CORS error in browser The Botd API endpoint is being called directly from the browser instead of your backend.
Only call the verification API from your server-side code, never from the browser.

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

Technical Specifications

Auth API Key
HTTPS REQUIRED
CORS YES
Category Security
Difficulty Intermediate
Verified: 2026-04-04

Related Tags

Similar APIs

View All →