Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dev.ranked.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Create an API key

Create an API Key

Go to Settings > API in your Ranked AI dashboard.
Choose your permission level:
  • Read Only (default) — fetch keywords, audits, backlinks, AI visibility, content, and reports
  • Read + Write — everything above, plus create reports, manage webhooks, and update preferences
API keys are shown only once when created. Copy and store it securely. Keys are tied to the project owner account and can only access projects you own directly.

​
2. Find your project ID

Every API call requires a project ID. List your projects to find it: 
curl https://app.ranked.ai/api/v1/projects \
  -H "Authorization: Bearer rk_live_your_api_key"
Response: 
{
  "data": [
    {
      "id": "40596405-c27c-4dfc-89e4-142c87846d66",
      "name": "My Website",
      "status": "active",
      "serviceType": "seo",
      "websiteUrl": "https://example.com"
    }
  ]
}
Copy the id value — you’ll use it in all subsequent calls.

​
3. Fetch your data

Use the project ID to pull keyword rankings, audit results, AI visibility, and more.

​
Keyword rankings

curl "https://app.ranked.ai/api/v1/projects/YOUR_PROJECT_ID/rankings/keywords?limit=10" \
  -H "Authorization: Bearer rk_live_your_api_key"
Each keyword includes positions across four channels:
FieldDescription
desktop_positionGoogle Desktop rank
mobile_positionGoogle Mobile rank
ai_mode_positionGoogle AI Mode rank
maps_positionGoogle Maps rank
net_changeCombined position change across all channels

​
What else is available

EndpointWhat it returns
GET /rankings/keywordsKeyword positions across Desktop, Mobile, AI Mode, Maps
GET /promptsAI visibility across ChatGPT, Claude, Gemini, Perplexity, Grok, Meta
GET /audits/latestLatest site audit results with issue counts
GET /backlinks/summaryBacklink profile with referring domains
GET /contentContent calendar with status and scheduling
GET /reportsShareable SEO report links
POST /webhooksReal-time notifications when data changes
See the full API reference for all endpoints and parameters.

​
Next steps

API Reference

Full endpoint documentation with examples.

Webhooks

Get notified when keyword positions update, content changes, or audits complete.

MCP Integration

Connect Ranked AI to ChatGPT, Claude, or Cursor.

Agency Dashboard

Build a custom client dashboard with the API and webhooks.