Bot Detector API

Overview

To use Bot Detector, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

https://api.apiverve.com/v1/botdetector

Example

How to call the Bot Detector API in different programming languages.

curl -X GET \
  "https://api.apiverve.com/v1/botdetector?ua=Googlebot%2F2.1%20(%2Bhttp%3A%2F%2Fwww.google.com%2Fbot.html)" \
  -H "X-API-Key: your_api_key_here"

const response = await fetch('https://api.apiverve.com/v1/botdetector?ua=Googlebot%2F2.1%20(%2Bhttp%3A%2F%2Fwww.google.com%2Fbot.html)', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/botdetector?ua=Googlebot%2F2.1%20(%2Bhttp%3A%2F%2Fwww.google.com%2Fbot.html)', headers=headers)

data = response.json()
print(data)

package main

import (
    "fmt"
    "io"
    "net/http"

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/botdetector?ua=Googlebot%2F2.1%20(%2Bhttp%3A%2F%2Fwww.google.com%2Fbot.html)", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

{
  "status": "ok",
  "error": null,
  "data": {
    "userAgent": "Googlebot/2.1 (+http://www.google.com/bot.html)",
    "isBot": true,
    "bot": {
      "name": "Googlebot",
      "category": "search_engine",
      "url": "http://www.google.com/bot.html",
      "reputation": "trusted",
      "shouldBlock": false
    }
  }
}

Authentication

The Bot Detector API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Bot Detector API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Bot Detector API:

Response

The Bot Detector API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <userAgent>Googlebot/2.1 (+http://www.google.com/bot.html)</userAgent>
    <isBot>true</isBot>
    <bot>
      <name>Googlebot</name>
      <category>search_engine</category>
      <url>http://www.google.com/bot.html</url>
      <reputation>trusted</reputation>
      <shouldBlock>false</shouldBlock>
    </bot>
  </data>
</response>

status: ok
error: null
data:
  userAgent: Googlebot/2.1 (+http://www.google.com/bot.html)
  isBot: true
  bot:
    name: Googlebot
    category: search_engine
    url: http://www.google.com/bot.html
    reputation: trusted
    shouldBlock: false

Response Structure

All API responses follow a consistent structure with the following fields:

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Bot Detector through GraphQL to combine it with other API calls in a single request. Query only the bot detector data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  botdetector(
    input: {
      ua: "Googlebot/2.1 (+http://www.google.com/bot.html)"
    }
  ) {
    userAgent
    isBot
    bot {
      name
      category
      url
      reputation
      shouldBlock
    }
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Bot Detector API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Bot Detector requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Bot Detector API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Bot Detector

Official Bot Detector packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Bot Detector works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in Bot Detector, you might also like these APIs:

VPN Proxy Detector

VPN Detector is a simple tool for detecting VPN usage. It returns a boolean value indicating whether the IP address is using a VPN or not.

1 credit per call

USB Vendor Lookup

USB Vendor Lookup allows you to identify USB device manufacturers and products by their vendor ID and product ID. It uses the Linux USB ID Repository, which contains thousands of USB vendor and product identifiers.

1 credit per call

Tor Node Detector

Tor Detect is an API that checks whether a given IP address belongs to a known Tor exit node. Useful for security, access control, and analytics.

1 credit per call