Skip to main content
GET
Get your current credit usage and remaining limit
Check how many API credits you have remaining for the current billing period.
  • Total credits available for your subscription, including active top-ups
  • Credits already used
  • Remaining credits
  • Your current subscription plan

Authorizations

X-API-KEY
string
header
required

API key required to access the endpoints. Generate one from your dashboard at https://openapi.coinstats.app and pass it in the X-API-KEY request header. Never expose your key in client-side code.

Response

Get current credit usage and remaining limit

totalCredits
number
required

Total credit limit for the current billing period, including active top-ups

Example:

100000

usedCredits
number
required

Credits already used in the current billing period

Example:

45000

remainingCredits
number
required

Remaining credits available for the current billing period

Example:

55000

subscription
string
required

Current subscription plan name

Example:

"PRO"