Threat intelligence API / Reference / Account

Account endpoints

Credits left, tier and scopes for the calling key. Free to call.

GET /me

GET /me

Your plan, credits left and key · 0 credits per call

What this key can do and how much budget is left, in one call.

Costs nothing (weight 0), so an agent or a cron job can check before a batch instead of parsing headers off every response. Reads the same per-key bucket that every request is charged against, so `used_today` matches the `X-RateLimit-Remaining` header on your last call. Works with an API key or a bearer minted from one.

Response 200 · AccountMeResponse

FieldTypeMeaning
tier *string
rate_limit *stringPer-minute burst limit for this key, e.g. 120/minute
credits *AccountCreditsInfo
key *AccountKeyInfo
request_costs *objectCredits per request by endpoint family; everything else costs `default`
docsstring
curl -H "X-API-Key: $TC_KEY" \
  "https://threatcluster.io/api/public/v1/me"