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.
Base URL
Every request is made over HTTPS to the base URL below. Plain HTTP is rejected in production.
https://rankspire.tech/api/v1Response envelope
Successful responses wrap results in a data property. List endpoints add a meta object with pagination details (total, limit, offset). Use limit (max 1000) and offset query parameters to page through large collections.
{
"data": [ ... ],
"meta": { "total": 412, "limit": 100, "offset": 0 }
}Versioning
Breaking changes are only introduced in a new major version path (/api/v2). Additive changes — new fields, new endpoints — can ship at any time, so clients should ignore unknown fields.
Background work
Long-running operations such as audits, data collection, indexing submissions and reports are processed by background jobs. These endpoints return immediately with a job or resource ID. Poll the resource (or GET /jobs/{id}) to follow progress.