Developers
Rankspire API documentation
Everything in the dashboard is available programmatically. Authenticate with an API key, call REST endpoints under /api/v1, or connect AI agents through the MCP server.
curl https://rankspire.tech/api/v1/websites \
-H "Authorization: Bearer $RANKSPIRE_KEY"Getting started
- API overview The Rankspire REST API gives programmatic access to every dataset in your workspace: websites, keywords, Search Console, Google SERP, AI visibility, campaigns, audits, indexing and reports. All endpoints live under /api/v1, accept and return JSON, and are scoped to the workspace that owns the API key.
- Authentication Authenticate every request with an API key in the Authorization header using the Bearer scheme. Create keys in Dashboard → API. Keys are shown once, stored as SHA-256 hashes, and can be rotated or revoked at any time.
- Quick start Make your first requests in under five minutes.
Resources
- Accounts Inspect the workspace, plan, limits, usage and credit balance associated with the API key.
- Websites Websites are the core resource. Track your own sites, client sites and competitors — no ownership verification is required for SERP and AI tracking.
- Site tags Tags organize websites by client, vertical or team. Assign tags with PATCH /websites/{id}.
- Keyword groups Groups such as Brand, Commercial, Informational, Transactional, Local or Custom organize keywords for reporting.
- Keywords Tracked keywords with positions, search volume, difficulty, intent, target URL and approval status.
Analytics
- Search Console First-party performance from Google Search Console for connected properties. Data is imported with read-only OAuth access and typically lags two days.
- Google SERP Ranking snapshots for any domain — your sites, client sites and competitors — without ownership verification.
- AI analytics How AI assistants mention, rank and cite a domain. Only models with a configured integration return live data.
Execution
- SEO campaigns Auto SEO and Full SEO campaigns. Campaigns are created as drafts; launching starts billing and happens in the dashboard.
- SEO audits Technical SEO audits covering crawlability, on-page, performance, structured data, mobile and security.
- Indexing Submit URLs to IndexNow and, when configured, the Google Indexing API, and stream crawler visits from your server logs. Submission confirms delivery; it does not guarantee indexing or ranking.
- Reports Generate reports for campaigns, Search Console, SERP, AI visibility, technical SEO and indexing in PDF, CSV or JSON.
- PDF reports Download generated files directly. PDF reports include KPIs, charts and tables, and use your workspace brand when whiteLabel is true.
- Jobs Background job status for audits, data collection, indexing and reports.
Reference
- Errors & limits Errors use conventional HTTP status codes and a consistent JSON body.
- API keys Manage keys in Dashboard → API. Owners and admins can create, rotate and revoke keys; every action is recorded in the workspace activity log.
- MCP server Connect AI agents to Rankspire with the Model Context Protocol. The server uses the stateless streamable HTTP transport at /api/mcp and authenticates with the same API keys.