RankBits API
AI visibility scans from your own workflow
Create scans asynchronously, check plan and credit usage, and retrieve detailed AI visibility results over HTTP.
Quick start
Samples update when you change the token or language.
API access
API tokens are available to every registered RankBits user, including free accounts after email verification.
Authentication
Send your token in the `Authorization` header. Keep tokens server-side and revoke them from this page if they are exposed.
Authorization: Bearer rb_your_token_hereEndpoints
| Method | Endpoint | Use |
|---|---|---|
| GET | /v1/me | Returns user, plan, monthly response budget, and purchased credits. |
| POST | /v1/scans | Creates a scan and starts it in the background. Returns immediately with IDs and links. |
| GET | /v1/scans/{id} | Retrieves status, progress, prompts, aggregate metrics, and result rows for your scan. |
| POST | /v1/scans/{id}/tracking | Enables scheduled tracking for a completed scan. Running, pending, or failed scans return 400. |
| GET | /v1/scans/{id}/tracking | Returns tracking status, latest aggregate, visibility history, mention/citation history, and related scan IDs. |
MCP server
RankBits is also available as a remote Model Context Protocol server, so AI agents (Claude, Cursor, ChatGPT, and other MCP clients) can run and track scans directly. It exposes the same capabilities as the REST API and authenticates with the same tokens.
{
"mcpServers": {
"rankbits": {
"type": "http",
"url": "https://rankbits.com/mcp",
"headers": { "Authorization": "Bearer rb_your_token_here" }
}
}
}Tools: get_account, list_providers, list_scans, create_scan, get_scan, enable_tracking, get_scan_tracking.
Create Scan
The scan endpoint accepts the same limits as the app. It checks email verification, plan engines, brand limits, cooldowns, and available response credits before starting.
Scan Results
While a scan is running, results include metadata, prompts, aggregate data available so far, and progress counts. Completed scans include answer text, citations, competitor stats, prompt breakdown, share of voice, and visibility scores.
{
"scan": {"public_id": "abc123", "status": "done"},
"progress": {"completed_results": 70, "expected_results": 70, "complete": true},
"aggregate": {"overall": {}, "providers": {}, "comparison": []},
"prompts": [],
"results": [],
"prompt_breakdown": []
}Tracked Scan Details
Use tracking endpoints after a scan completes. Tracking follows the scan lineage: the original completed scan is the root, and each scheduled run becomes a related scan that can be fetched through the normal results endpoint.
Enables scheduled tracking for one owned completed scan. The scan must be done; pending, analyzing, running, draft, and error scans return 400.
{"frequency_days": 7}The frequency is clamped to the user's plan minimum. Free accounts are weekly by default; paid plans can allow shorter cadences.
Reads tracking state and lineage history for an owned scan. You can pass either the root scan ID/public ID or any tracked run ID/public ID in that lineage.
{
"scan": {
"id": 123,
"public_id": "abc123",
"status": "done",
"domain": "example.com",
"brand_name": "Example"
},
"tracking": {
"enabled": true,
"frequency_days": 7,
"last_tracked_at": "2026-07-04T12:34:56+00:00"
},
"latest_scan": {"id": 124, "public_id": "def456", "status": "done"},
"aggregate": {
"overall": {"score": 42.5, "mention_rate": 55.0, "citation_rate": 30.0},
"providers": {},
"comparison": []
},
"history": [
{
"at": "2026-07-04T12:34:56+00:00",
"scan_public_id": "abc123",
"overall_score": 42.5,
"raw_score": 42.5,
"mention_rate": 55.0,
"citation_rate": 30.0,
"mention_count": 12,
"citation_count": 5
}
],
"related_scans": [
{"id": 123, "public_id": "abc123", "status": "done", "results": "/v1/scans/abc123"},
{"id": 124, "public_id": "def456", "status": "done", "results": "/v1/scans/def456"}
]
}For full answers, citations, prompts, and row-level provider results, call GET /v1/scans/{public_id} for any item in related_scans.
Provider keys
Use these values in the optional providers array. Omit the field to use every engine allowed by your plan.
ChatGPT answers with fast, general-purpose web-aware reasoning.
ChatGPT answers for upgraded accounts (Plus or above), with deeper reasoning and higher-quality synthesis.
Google AI Mode-style search response.
Google AI Overview-style summary.
Gemini answers with strong Google-native reasoning and broad web context.
Traditional Google organic results for baseline search visibility.
Traditional Bing organic results for baseline search visibility.
Bing Copilot AI-generated search answers with source references.
Privacy-focused DuckDuckGo organic results for broader search visibility.
Yahoo organic results for an additional consumer search baseline.
Perplexity search answers with citations from current web sources.
Claude answers with careful summarization and citation-aware reasoning.
Claude Pro responses for premium long-form analysis and strategy.
Tavily web search for AI-friendly source discovery and citations.
Exa neural search for finding semantically relevant web sources.
Gemini Pro responses for richer analysis on complex prompts.