Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cs2cap.com/llms.txt

Use this file to discover all available pages before exploring further.

The Account API lets you inspect your current API key’s metadata — including tier, rate limits, and quota details — and reissue the key when you need to rotate your credentials. Reissuing a root key immediately revokes all child keys issued from your account — a single step to rotate all credentials.

​
GET /account/key

Returns metadata for the authenticated key. When called with a session JWT, it resolves to the account’s active root key. When called with a child (sub-key) token, it returns that child key’s own metadata. Tiers: Free, Starter, Pro, Quant · Auth: Session JWT or API key · Rate limit: Standard per-tier RPM 
curl -sS \
  -H "Authorization: Bearer $CS2C_API_KEY" \
  "$CS2C_API_BASE/account/key"
Response example
{
  "key": {
    "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "key_prefix": "sk_live_root",
    "name": null,
    "root_key_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "is_root_key": true,
    "is_active": true,
    "created_at": "2026-03-02T10:30:00Z",
    "last_used_at": "2026-03-02T11:15:00Z",
    "expires_at": null,
    "quota_requests_per_month_override": null,
    "rate_requests_per_minute_override": null,
    "effective_quota_requests_per_month": 500000,
    "effective_rate_requests_per_minute": 300
  }
}
​
key.id
string
UUID for this key record.
​
key.key_prefix
string
Human-readable prefix indicating key type. Root keys use sk_live_root; child keys use sk_live_child.
​
key.name
string | null
Optional display name. null for root keys unless one has been set.
​
key.root_key_id
string
UUID of the parent root key. Equal to id for root keys.
​
key.is_root_key
boolean
true for root keys, false for child keys.
​
key.is_active
boolean
false for revoked or expired keys.
​
key.created_at
string
ISO 8601 timestamp when the key was created.
​
key.last_used_at
string | null
ISO 8601 timestamp of the most recent authenticated request, or null if the key has never been used.
​
key.expires_at
string | null
ISO 8601 expiry timestamp, or null for non-expiring keys.
​
key.quota_requests_per_month_override
integer | null
Child-specific monthly request cap, or null if the tier default applies.
​
key.rate_requests_per_minute_override
integer | null
Child-specific per-minute rate limit, or null if the tier default applies.
​
key.effective_quota_requests_per_month
integer
The quota actually enforced for this key, accounting for any override.
​
key.effective_rate_requests_per_minute
integer
The RPM limit actually enforced for this key, accounting for any override.
Child keys can authenticate normal data requests. Calling this endpoint with a child key token returns that child key’s own metadata, not the root key’s.

​
POST /account/key/reissue

Replaces your active root key and immediately revokes all child keys issued from your account. Use this whenever you need to rotate credentials or suspect a key has been compromised. Tiers: Free, Starter, Pro, Quant · Auth: Session JWT or root API key · Rate limit: Standard per-tier RPM 
curl -sS -X POST \
  -H "Authorization: Bearer $CS2C_API_KEY" \
  "$CS2C_API_BASE/account/key/reissue"
Response example
{
  "key": "sk_live_<xxxx>",
  "key_prefix": "sk_live_root",
  "id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
  "created_at": "2026-03-02T11:20:00Z",
  "message": "Store this key securely. It will not be shown again."
}
​
key
string
The new plaintext API key. Shown only once in this response.
​
key_prefix
string
Key type prefix. Always sk_live_root for root keys.
​
id
string
UUID for the new key record.
​
created_at
string
ISO 8601 timestamp when the new key was created.
The new key value is returned once only. Copy and store it securely before closing the response. You cannot retrieve the plaintext key again after this. All previously issued child keys are immediately revoked when you reissue the root key.
Email verification is required before a key can be issued or reissued. Child keys cannot call this route — you must authenticate with a session JWT or the root API key.
Last modified on May 23, 2026