The RankedByAI REST API gives you read-only programmatic access to the same visibility data your dashboard shows: grades, mention rates, prompts, raw AI answers, cited sources and citation gaps.
Base URL: https://rank.zalize.com/api/v1
Authentication
Every request needs an API key in the Authorization header:
``
Authorization: Bearer rk_your_api_key
Create keys in Dashboard → Settings → API keys. A key is scoped to its workspace, shown exactly once at creation, and stored server-side only as a SHA-256 hash. Revoke keys you no longer use — revocation is immediate.
Endpoints
All endpoints are GET and return JSON with ok: true on success.
| Endpoint | Returns |
| --- | --- |
| /api/v1/visibility | Visibility summary: latest grade, mention rate, citation funnel, sampled platforms, tracked competitors, week-over-week comparison. |
| /api/v1/history | Full scan history: date, grade, mention rate and detected changes per scan. |
| /api/v1/prompts | Tracked prompts (buyer questions) with tags, intent, country and enabled status. |
| /api/v1/answers | Raw AI answers from the latest scan, with model and mention flags. |
| /api/v1/sources | Domains cited by AI answers in the latest scan, with counts and categories. |
| /api/v1/urls | URL-level citation stats for the latest scan. |
| /api/v1/gaps | Citation gaps: URLs that cite competitors while your brand is absent. |
An unauthenticated GET /api/v1 returns this endpoint index as JSON.
Example
``bash``
curl -s https://rank.zalize.com/api/v1/visibility \
-H "Authorization: Bearer rk_your_api_key"
Returns:
``json``
{
"ok": true,
"business": "Acme Dental",
"platforms": ["grok", "grok-mini", "grok-grounded"],
"latest": { "date": "2026-08-03", "grade": "B", "mention_rate": 41, "scan_id": "…" },
"previous": { "date": "2026-07-27", "grade": "C", "mention_rate": 33, "scan_id": "…" },
"scans_total": 12
}
Rate limits
Each key may make 60 requests per minute. Over the limit, requests return 429 with a Retry-After: 60 header.
Errors
| Status | error | Meaning |
| --- | --- | --- |
| 401 | unauthorized | Missing, malformed or revoked API key. |
| 404 | not_found | Unknown endpoint path. |
| 404 | project_not_found | The key's workspace has no project data yet. |
| 405 | method_not_allowed | Only GET is supported on /api/v1/*. |
| 429 | rate_limited | Over the per-key rate limit — retry after 60 seconds. |
Scope and honesty
The API is read-only by design — no endpoint can start scans, change prompts or modify settings. The data mirrors your dashboard exactly, including its honest coverage limits.
Want to use this data inside Claude, Cursor or another MCP client? See the MCP server guide.