Authentication

FullHunt uses API key authentication. Include your key in the X-API-KEY header on every authenticated API request.

Do not expose FullHunt API keys in browser code, mobile apps, public repositories, analytics tools, or client-side logs. Route client-facing requests through your backend.

API Key Setup

Create or sign in to your account

Use your FullHunt account to access API credentials and plan information.

Copy your API key

Open profile settings and copy the active API key.

Send the key with each request

Add the key to the X-API-KEY request header.

Header

X-API-KEY: xxxx-xxxx-xxxx-xxxxxx

Verify Your Key

Use /auth/status before building deeper integrations. The response confirms that the key is valid and returns the account plan and credit context.

curl "https://fullhunt.io/api/v1/auth/status" \
  -H "X-API-KEY: xxxx-xxxx-xxxx-xxxxxx"

import requests

response = requests.get(
    "https://fullhunt.io/api/v1/auth/status",
    headers={"X-API-KEY": "xxxx-xxxx-xxxx-xxxxxx"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://fullhunt.io/api/v1/auth/status", {
  headers: { "X-API-KEY": "xxxx-xxxx-xxxx-xxxxxx" },
});

if (!response.ok) {
  throw new Error(`FullHunt authentication failed: ${response.status}`);
}

console.log(await response.json());

Replace xxxx-xxxx-xxxx-xxxxxx with your actual API key before sending requests.

Successful Response

Authentication status

{
  "message": "",
  "status": 200,
  "user": {
    "company": "ACME",
    "email": "john.smith@acme.com",
    "first_name": "John",
    "last_name": "Smith",
    "plan": "enterprise"
  },
  "user_credits": {
    "credits_usage": 1,
    "max_results_per_request": 300000,
    "remaining_credits": 2999,
    "total_credits_per_month": 3000
  }
}

Response Fields

Field	Description
`status`	HTTP status code
`message`	Empty on success, error description on failure
`user`	User and organization information for the API key
`user_credits`	Monthly credit usage, remaining credits, and per-request result limits

User Object

Field	Description
`company`	Company name
`email`	User email address
`first_name`	User’s first name
`last_name`	User’s last name
`plan`	Current subscription plan

User Credits Object

Field	Description
`credits_usage`	Credits used this month
`max_results_per_request`	Maximum results per API request
`remaining_credits`	Remaining credits for the month
`total_credits_per_month`	Total credits allocated per month

Common Failures

Status	Meaning	Recovery
`401 Unauthorized`	Missing or invalid API key	Confirm the `X-API-KEY` header is present and copied correctly
`403 Forbidden`	Key is valid but lacks access	Check the account plan or contact support for access changes
`429 Too Many Requests`	Rate limit exceeded	Back off and review Rate Limiting

Key Handling Checklist

Load API keys from server-side environment variables or a secrets manager.
Rotate keys after accidental exposure or team access changes.
Avoid writing API keys to request logs, crash reports, traces, and analytics events.
Use separate keys or accounts for development, staging, and production when your workflow requires isolation.

Get Started

Integration Foundations

Core Attack Surface

Search & Intelligence

Enterprise APIs

Nexus APIs

OEM APIs

Public APIs

Generated API Reference

Agentic AI (MCP)

API Key Setup

Verify Your Key

Successful Response

Response Fields

User Object

User Credits Object

Common Failures

Key Handling Checklist

​API Key Setup

​Verify Your Key

​Successful Response

​Response Fields

​User Object

​User Credits Object

​Common Failures

​Key Handling Checklist

API Key Setup

Verify Your Key

Successful Response

Response Fields

User Object

User Credits Object

Common Failures

Key Handling Checklist