REST API
Read your calendar, GSC metrics, LLM visibility, and keyword pool — or trigger publishes and settings changes — with domain-scoped API keys.
API keys#
Create keys in the app under Integrations → API keys (per domain). Each key is tied to one onboarding/domain — safe for agencies handing clients separate access.
| Field | Required | Where to find it |
|---|---|---|
| Read scope | Required | Default. GET endpoints only — calendar, articles, GSC, keywords, settings. |
| Write scope | Optional | POST/PATCH — publish, reschedule, status changes, settings updates. Requires Growth plan. |
Shown once
Copy the full key when created (rnk_…). Rankealo stores only a prefix; lost keys must be revoked and recreated.Authentication#
Send the key on every request:
Authorization: Bearer rnk_your_api_key_hereBase URL: https://app.rankealo.ai/api/v1/ (or your deployment host). Paths mirror MCP tool names, e.g. calendar, articles, gsc/overview.
Read endpoints (GET)#
- calendar
- articles · articles/:id
- gsc/overview · gsc/opportunities
- llm-visibility · seo-health · keywords · settings
- seo-context/* — performance, briefs, geo-health, competitor intel, refresh candidates, etc.
Write endpoints (POST / PATCH)#
Require write-scoped keys and active billing for mutating actions:
- POST articles/:id/publish
- POST articles/:id/reschedule
- POST articles/:id/status
- POST seo-agent/chat
- PATCH settings/autopublish · content-preferences · seo-agent · internal-linking
Publish calls the same pipeline as the UI — including billing gate and publish claim.
OpenAPI#
The public OpenAPI 3 document is at https://rankealo.ai/openapi.json (alias: /api/openapi/v1). Each operation has a unique operationId, description, typed parameters, and JSON response schemas so LLM function-calling clients can import it directly.
Rate limits#
Default quota is 60 requests per minute per API key. Successful responses include IETF RateLimit plus RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset. A 429 also includes Retry-After (seconds). Agents should honor those headers instead of guessing.
Zapier & Make#
Connect Rankealo to Zapier or Make without a native app — use Webhooks/HTTP modules against https://app.rankealo.ai/api/v1 or import the OpenAPI catalog for Make.
Still stuck? Contact support
