citare
Product · API

Citare API

42 REST endpoints covering every Citare product surface, 9 webhook events, type-safe TypeScript + Python SDKs auto-generated from OpenAPI. Spec-first architecture means every new feature ships in the API on day one. Read access at Pro; full write at Agency.

Five things you get

42 REST endpoints, one OpenAPI spec

Every product surface exposed as REST — Site Explorer, Keywords Explorer, Rank Tracker, Site Audit, Brand Radar, Reports, Tools. Single OpenAPI spec drives REST docs + MCP tool catalog + SDK generation. Spec-first means every new product ships in the API on day one.

9 webhook events

Subscribe to events: brand-radar-dispatch-completed, site-audit-completed, rank-change, new-backlink, scheduled-report-ready, plus 4 more. HMAC-SHA256 signed, idempotent delivery, retry-with-exponential-backoff, dead-letter queue for diagnostics.

TypeScript + Python SDKs

Auto-generated from OpenAPI spec, published to npm + PyPI. Type-safe everywhere. Same operation catalog as MCP — call the same endpoints from your SDK, from your agent via MCP, or from a curl pipeline. Available in 12 languages via OpenAPI generators.

Scoped tokens + tier-rate-limited

Bearer auth with scope tokens (read:rank-tracker, write:projects, etc.). Rate limits scale with tier — Free 60 req/min, Pulse 600, Pro 6,000, Agency 60,000, Enterprise custom. Audit log of every API call with last_used_at touch on the token.

Read API at Pro · Write API at Agency

Read access (GET endpoints) opens at Pro tier ($119/₹9,999). Full write API (POST/PUT/DELETE) at Agency tier ($299/₹24,999) — required for white-label resellers running portfolio operations programmatically.

Frequently asked questions

Where's the API documentation?

Live OpenAPI spec at citare.ai/openapi.json — paste into Postman, Insomnia, or any OpenAPI-compatible tool. Human-readable docs at /docs/api with endpoint examples + auth + error reference. SDK reference docs ship with each SDK package on npm + PyPI.

Which tier do I need for API access?

Read API (GET) at Pro ($119/₹9,999). Full read+write API at Agency ($299/₹24,999). MCP server access also at Pro — bidirectional with REST API, scoped via the same bearer tokens.

Is there a rate limit?

Yes, tier-scaled: Free 60 req/min, Pulse 600, Pro 6,000, Agency 60,000, Enterprise custom. Rate limit headers (X-RateLimit-Remaining, X-RateLimit-Reset) on every response. Burst tolerance via KV-backed token bucket.

How does the API auth work?

Bearer tokens via Authorization header. Generate tokens in /app/settings/api with optional scope restrictions (read-only, project-scoped, expiry-bound). Tokens are AES-GCM-encrypted at rest; audit log tracks every call.

Can I integrate with Zapier / n8n / Make?

Yes via webhooks (no Zapier app yet but webhook-trigger nodes in n8n + Make connect directly). Native Zapier integration on the roadmap for Phase 12.

Does the API support pagination + filtering?

Yes. Cursor-based pagination on every list endpoint (limit + cursor params). Server-side filtering by date range, project, status, type. Full-text search on text-heavy resources (Query Guide, Audit findings). Response includes pagination_token for cursor continuation.

Build on Citare

Read API at Pro ($119/₹9,999) — full write API at Agency ($299/₹24,999). TS + Python SDKs ship from day one.

Related