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.
Base URL
https://app.ranked.ai/api/v1
Authentication
All requests require a Bearer token:
curl https://app.ranked.ai/api/v1/projects \
-H "Authorization: Bearer rk_live_your_api_key"
How it works
All data in the API is organized by project. A project represents one website you’re tracking.
GET /projects → list your projects (get project IDs)
GET /projects/{projectId}/rankings/keywords → keyword data for that project
GET /projects/{projectId}/audits/latest → audit data for that project
GET /projects/{projectId}/prompts → AI visibility for that project
...
GET /projects to get your project IDs.
Step 2: Use a project ID in all other endpoints to fetch keywords, audits, backlinks, content, prompts, and reports for that specific project.
Step 3 (optional): Set up webhooks with a project ID to receive notifications when data changes for that project.
Each API key can access all projects owned by the account that created it. If you manage multiple client websites, they’ll all appear in the projects list.
Endpoints
Projects
| Method | Path | Description |
|---|
| GET | /projects | List your SEO projects |
Keywords
| Method | Path | Description |
|---|
| GET | /projects/{id}/rankings/keywords | List keyword positions |
| GET | /projects/{id}/rankings/keywords/{keywordId}/history | Position history for a keyword |
AI Visibility
| Method | Path | Description |
|---|
| GET | /projects/{id}/prompts | List AI visibility prompts |
| GET | /projects/{id}/prompts/{promptId} | Prompt detail with per-model data |
| GET | /projects/{id}/prompts/{promptId}/history | Response history with citations |
Audits
| Method | Path | Description |
|---|
| GET | /projects/{id}/audits | List audit tasks |
| GET | /projects/{id}/audits/latest | Most recent completed audit |
| GET | /projects/{id}/audits/{auditId}/issues | Issues for a specific audit |
Backlinks
| Method | Path | Description |
|---|
| GET | /projects/{id}/backlinks | Tracked backlink targets |
| GET | /projects/{id}/backlinks/summary | Aggregated backlink metrics |
| GET | /projects/{id}/backlinks/domains | Referring domains |
| GET | /projects/{id}/backlinks/history | Daily new/lost history |
| GET | /projects/{id}/backlinks/anchors | Anchor text analysis |
Content
| Method | Path | Description |
|---|
| GET | /projects/{id}/content | Content calendar items |
| GET | /projects/{id}/content/{contentId} | Content detail with body |
| GET, PATCH | /projects/{id}/content/preferences | Content preferences |
Reports
| Method | Path | Description |
|---|
| GET, POST | /projects/{id}/reports | List or create report links |
| GET, DELETE | /projects/{id}/reports/{reportId} | Get or delete a report |
Webhooks
| Method | Path | Description |
|---|
| GET, POST | /webhooks | List or create webhook subscriptions |
| GET, PATCH, DELETE | /webhooks/{webhookId} | Manage a webhook |
| POST | /webhooks/{webhookId}/test | Send a test delivery |
POST, PATCH, and DELETE endpoints require an API key with Read + Write permissions.
