RankrRankr/Documentation
Menu
API Reference

A read-only HTTP API for reading your workspace's brand, prompt, and mention data — built for integrations, AI agents (MCP, Zapier), and custom dashboards.

Base URL
https://api.rankr.so/v1

Authentication

Every authenticated request carries an API key in the Authorization header. Keys are scoped to a single workspace — create them under Settings → API Keys. The plaintext key is shown once at creation, so store it somewhere safe.

cURL
curl 'https://api.rankr.so/v1/brands' \
  -H 'Authorization: Bearer rnkr_live_…'

Rate limits

Each API key is limited to 60 requests per minute and 1,000 requests per hour. When you exceed a limit you'll get a 429 response with a Retry-After header telling you how many seconds to wait. Build retries with exponential backoff and honor that header.

Errors

Errors use standard HTTP status codes and a consistent body shape, so you can branch on the error.code field rather than parsing messages.

JSON
{
  "error": {
    "code": "not_found",
    "message": "Brand not found"
  }
}
  • unauthorizedmissing, invalid, revoked, or expired key.
  • bad_requestmalformed parameters.
  • not_foundresource doesn't exist or isn't in your workspace.
  • rate_limitedtoo many requests, back off and retry.
  • internalour bug, please contact support.

API Reference

Every resource you can read, grouped by type. Each endpoint has live request and response examples.