API · Authentication

API keys & auth

The API authenticates with subscriber API keys. Any active paid plan (Trader or Pro) can create keys; the Free tier has no API access. A key acts only on its owner's data and is auto-revoked if the subscription lapses.

Generate a key

Create keys in Settings → API keys. Each key is named so you can tell them apart, and is shown in full exactly once at creation. Trigr stores only a hash plus a short display prefix (trigr_sk_…), so copy it somewhere safe. You can revoke a key at any time.

Send the key

Pass the key in the Authorization header as a bearer token (an x-api-key header is also accepted):

Shell
curl https://trigr.xyz/api/v1/whoami \
  -H "Authorization: Bearer trigr_sk_your_key_here"

GET /api/v1/whoami is a smoke endpoint that echoes the resolved owner, tier, and rate-limit state; it is handy for verifying a key works:

Response
{
  "userAddress": "0xabc…",
  "tier": "PRO",
  "apiKeyId": "key_…",
  "rateLimit": { "perMin": 60, "used": 1, "remaining": 59 }
}

Scoping & safety

  • Owner-scoped. A key only ever touches its owner's data: every endpoint filters by the key's account. A key can never read or act on another user's data.
  • Subscription-gated. Each request re-checks for an active paid subscription. If the plan lapses, the key stops working with a 403 until it's active again.
  • Rate-limited & audited. Every key has a per-minute rate limit, and every call is written to an audit log. See Rate limits & credits.
  • Tier perks. The trading and ML endpoints work on any paid plan; the Signals API is Pro-only.