Developer Documentation
Lead with deep people intelligence.
Ship in minutes.
Start with the deep-moat methods — sourced, 30-dimension evaluation of real people and companies. Then the included table-stakes endpoints, plus auth, rate limits, webhooks, MCP, n8n templates and SDKs. Everything you need to start building.
🚀 Quickstart
Your first API call in under 2 minutes
No API key needed to explore. Use
fxp_live_DEMO00000000000000000000000 for up to 500 free trial calls, or sign up for a full trial key.cURL
Python
JavaScript
Node.js
# Pull Trustpilot reviews for any company
curl -X POST https://api.foxapis.com/v1/brand/trustpilot/company \
-H "Content-Type: application/json" \
-H "X-API-Key: fxp_live_DEMO00000000000000000000000" \
-d '{"company": "stripe.com"}'
# Response:
{
"success": true,
"data": {
"company": "Stripe",
"trust_score": 4.2,
"total_reviews": 3847,
"rating_distribution": { "5_star": 68, "1_star": 12 }
},
"credits_used": 8,
"credits_remaining": 492
}
import requests
API_KEY = "fxp_live_DEMO00000000000000000000000"
BASE_URL = "https://api.foxapis.com"
def get_trustpilot(company):
response = requests.post(
f"{BASE_URL}/v1/brand/trustpilot/company",
headers={"X-API-Key": API_KEY},
json={"company": company}
)
return response.json()
# Call any of 51 endpoints the same way
data = get_trustpilot("stripe.com")
print(data["data"]["trust_score"]) # 4.2
# Chain multiple endpoints
g2 = requests.post(f"{BASE_URL}/v1/brand/g2/product",
headers={"X-API-Key": API_KEY},
json={"product": "stripe"}).json()
github = requests.post(f"{BASE_URL}/v1/developer/github/repo",
headers={"X-API-Key": API_KEY},
json={"repo": "stripe/stripe-python"}).json()
const foxapis = {
key: 'fxp_live_DEMO00000000000000000000000',
base: 'https://api.foxapis.com',
call: async (endpoint, body) => {
const res = await fetch(`${foxapis.base}${endpoint}`, {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': foxapis.key
},
body: JSON.stringify(body)
});
return res.json();
}
};
// Pull G2 reviews + GitHub stats in parallel
const [g2, github] = await Promise.all([
foxapis.call('/v1/brand/g2/product', { product: 'notion' }),
foxapis.call('/v1/developer/github/repo', { repo: 'makenotion/notion-sdk-js' })
]);
console.log(g2.data.rating, github.data.stars);
// npm install node-fetch (or use built-in fetch in Node 18+)
const API_KEY = 'fxp_live_DEMO00000000000000000000000';
async function foxCall(endpoint, body) {
const res = await fetch(`https://api.foxapis.com${endpoint}`, {
method: 'POST',
headers: { 'Content-Type': 'application/json', 'X-API-Key': API_KEY },
body: JSON.stringify(body)
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
return res.json();
}
// Example: competitor intelligence pipeline
const brand = 'linear.app';
const [trustpilot, similar, reddit] = await Promise.all([
foxCall('/v1/brand/trustpilot/company', { company: brand }),
foxCall('/v1/brand/similarweb/domain', { domain: brand }),
foxCall('/v1/brand/reddit/brand-mentions', { brand: 'Linear' })
]);
console.log({ trustpilot: trustpilot.data, similar: similar.data });
🔑 Authentication & API Keys
Secure, simple header-based auth
02
Add to header
Pass your key as
X-API-Key in every request header. Never in the URL.03
Keep it secret
Use environment variables. Never commit keys to GitHub. Rotate via dashboard if exposed.
04
Monitor credits
Every response includes
credits_used and credits_remaining.
# ✅ Correct — key in header
curl -H "X-API-Key: fxp_live_YOUR_KEY_HERE" ...
# ❌ Wrong — never put key in URL
curl https://api.foxapis.com/v1/...?key=fxp_live_...
# Environment variable pattern (recommended)
export FOXAPIS_KEY="fxp_live_YOUR_KEY_HERE"
curl -H "X-API-Key: $FOXAPIS_KEY" ...
⚡ Rate Limits & Plans
Credits reset monthly
How credits work: Commodity endpoints cost 2–15 credits per call; deep people-intelligence runs 5 credits per subject or 30 per sourced dossier (some Scale-only). Credits are deducted on success only — errors never cost credits.
# Credit costs by endpoint tier
2–3 credits → Open data: GitHub, Wikipedia, npm, PyPI, Hacker News, Chess.com, Last.fm...
8 credits → Light scrapes: Trustpilot, G2, YouTube, Bluesky, App Store, CoinGecko...
15 credits → Hard scrapes: Twitter/X, Instagram, TikTok, LinkedIn, web-traffic, AI-visibility...
5 cr / subject → People-intelligence comparisons (deep moat)
30 credits → Sourced dossiers & deep tech-stack detection (Scale plan)
🛡 Error Handling & Retry Logic
Handle errors gracefully
# All errors return consistent JSON
{
"success": false,
"error": "rate_limit_exceeded",
"message": "Monthly credit limit reached",
"credits_remaining": 0,
"resets_at": "2026-04-01T00:00:00Z"
}
# HTTP status codes
200 → Success
400 → Bad request (missing required field)
401 → Invalid or missing API key
402 → Insufficient credits
429 → Rate limit exceeded — retry after header tells you when
500 → Server error — safe to retry with exponential backoff
# Python retry pattern
import time, requests
def fox_call_with_retry(endpoint, body, retries=3):
for attempt in range(retries):
res = requests.post(endpoint, ...)
if res.status_code == 429:
time.sleep(2 ** attempt) # exponential backoff
continue
return res.json()
raise Exception("Max retries exceeded")
📖 Developer Guides
In-depth docs for every integration pattern
Authentication & API Keys
How to generate, rotate, and secure your API keys. Environment variables, key scopes, and best practices.
Webhooks Setup Guide
Configure real-time webhooks to receive alerts the moment a mention, signal, or threshold is detected.
MCP Integration (Claude & ChatGPT)
Connect FoxAPIs to Claude Desktop or any MCP-compatible AI agent in minutes. No-code setup.
n8n Workflow Templates
Ready-to-import n8n workflows for competitor monitoring, lead enrichment, and social listening automations.
Rate Limits & Best Practices
Understand credit costs per endpoint, implement retry logic, and optimize your API usage for maximum throughput.
LLM-Optimized Data Format
Use
?format=llm to get AI-ready responses with summaries and action suggestions built in.Searching Non-English Content
Search brand mentions in Vietnamese, Chinese, Japanese, and 96 more languages using the multilingual scan.
Building a Crisis Detection Agent
Step-by-step: build an autonomous agent that monitors brand health 24/7 and escalates when sentiment spikes.
Competitor Intelligence Pipeline
Automate weekly competitor reports using 5 endpoints in sequence. Email digest every Monday, zero manual work.
SDK & Client Libraries
Official and community SDKs for Python, JavaScript, Go, and more. One-line install, full type support.
Zapier & Make.com Integration
No-code workflows using FoxAPIs triggers and actions. Connect to 5,000+ apps without writing a line of code.
Error Handling & Retry Logic
Handle errors gracefully with smart retry strategies and exponential backoff. Full error code reference.
🔔 Webhooks
Real-time push — no polling required
Webhooks fire instantly when a brand mention, sentiment spike, or threshold event is detected. Register your endpoint once, receive events forever.
# Register a webhook endpoint
curl -X POST https://api.foxapis.com/v1/webhooks/register \
-H "X-API-Key: fxp_live_YOUR_KEY" \
-d '{
"url": "https://your-app.com/hooks/foxapis",
"events": ["mention.new", "sentiment.spike", "crisis.alert"],
"brand": "YourBrand",
"threshold": 0.3
}'
# Webhook payload you receive
{
"event": "sentiment.spike",
"brand": "YourBrand",
"timestamp": "2026-03-08T14:22:00Z",
"data": {
"sentiment_score": -0.68,
"delta": -0.41,
"sources": ["reddit", "twitter"],
"top_mention_url": "https://reddit.com/r/SaaS/..."
}
}
🤖 MCP Integration
Use FoxAPIs directly inside Claude, ChatGPT, and any AI agent
MCP (Model Context Protocol) lets any AI agent call FoxAPIs as a native tool. Ask Claude "What is Stripe's Trustpilot score?" and it calls the endpoint automatically.
# Add to claude_desktop_config.json
{
"mcpServers": {
"foxapis": {
"command": "npx",
"args": ["-y", "@foxapis/mcp-server"],
"env": {
"FOXAPIS_KEY": "fxp_live_YOUR_KEY_HERE"
}
}
}
}
# Now in Claude Desktop you can say:
# "Pull the G2 rating for Notion and compare with their Trustpilot score"
# Claude calls both endpoints and synthesizes the answer automatically
⚙️ n8n & No-Code Workflows
Automate without writing code
Weekly Competitor Report
Cron → 5 competitor API calls → Google Sheets update → Slack digest. Zero code.
Lead Enrichment on New CRM Contact
HubSpot webhook → FoxAPIs dossier pull → update CRM record with full intel.
Brand Crisis Alert
Webhook from MentionFox → sentiment check → Slack alert if score below threshold.
🧠 People Intelligence — the deep moat
Lead with these — sourced, 30-dimension evaluation of real people
These are the methods that deepen your moat. Multi-source, cited evaluation of real humans and companies that a bare model cannot fake. Names resolve with built-in disambiguation: hand a name and, if more than one person matches, you get a candidate list at no charge to lock in by id. The commodity scrapers further down are included table-stakes — useful, but anyone can wire them.
POST/v1/candidate_evaluateDeep multi-source evaluation of one candidate vs a role — 30-dimension sourced scorecard (async)🪙 async · 0 if unfindable
POST/v1/candidate_compareRank 2–10 candidates side by side in a hiring frame, on sourced evidence🪙 5 cr / candidate
POST/v1/exec_compareCompare 2–10 executives in a leadership / competitor-exec frame, on sourced evidence🪙 5 cr / exec
POST/v1/bulk_candidate_compareRun several candidate comparisons in one call — one set per open role🪙 5 cr / subject
POST/v1/vet_personSourced screening dossier on a person — history, affiliations, red flags🪙 30 cold / 0 cache
POST/v1/get_dossierFull sourced person dossier — same backing as vet_person, dossier framing🪙 30 / 0 cache
POST/v1/compare_peopleRank 2+ people side by side on 30 dimensions, context-aware🪙 5 cr / subject
POST/v1/compare_subjectsContext-aware side-by-side of any 2–10 real subjects🪙 5 cr / subject
📊 More Intelligence
Still deep, still sourced — investor, founder, sales, audience, intent, contact
POST/v1/get_investor_reportVerified investor / firm track-record snapshot🪙 30 / free thin
POST/v1/get_entrepreneur_reportDeep founder due-diligence report (async)🪙 async · 0 if unfindable
POST/v1/generate_sales_dossierSourced pre-call sales dossier from a company domain🪙 30 cr
POST/v1/analyze_influencerAudience-authenticity + brand-fit score with fraud flags🪙 30 basic / 50 full
POST/v1/score_intentBuyer-intent score of a social post on real signal🪙 2 cr
POST/v1/find_contactResolve a named person to a verified reachable contact🪙 100 / 0 unfindable
🧩 Included — table-stakes
Commodity enrichment + web-extraction + per-platform signal endpoints — included on every plan, but they don't deepen your moat
Everything below ships with every plan and is worth wiring up — but anyone can call it. It runs on capacity you've already paid for. The People Intelligence methods above are what set your agent apart.
Person enrichment & contact
POST/v1/enrich_personPerson enrichment (light / deep)🪙 included
POST/v1/find_emailFind a verified email at a domain🪙 100 / 0
Social
Brand
POST/v1/brand/trustpilot/companyTrustpilot — TrustScore, rating distribution, review count🪙 8 crRef ↗
Talent
Developer
POST/v1/developer/stackoverflow/questionStack Overflow — score, views, tags, accepted answer🪙 3 crRef ↗
AI Visibility
POST/v1/ai-visibility/perplexity/answerShared AI answer — brand mentions in AI search answers🪙 15 crRef ↗
Content
Visual
Mobile
Crypto
POST/v1/crypto/defillama/protocolDeFiLlama — TVL, chain breakdown, token price for DeFi protocol🪙 5 crRef ↗
OSINT
Science & Medicine
POST/v1/science/pubmed/searchPubMed — biomedical paper search, abstracts, authors, citations🪙 5 crRef ↗
POST/v1/science/biorxiv/preprintsbioRxiv — preprint search by topic/date, before peer review🪙 5 crRef ↗
POST/v1/science/clinicaltrials/searchClinicalTrials.gov — active trials by condition, drug, phase🪙 5 crRef ↗
Patents & IP
POST/v1/patents/uspto/searchUSPTO PatentsView — US patents by keyword, assignee, CPC code🪙 5 crRef ↗
Labor & Salaries
Gaming
Ecommerce
Music