Skip to main content
Use this endpoint to check your remaining API credit balance. Poll it to monitor usage and confirm you have enough credits before a large batch of requests. You can also view credits and usage in your dashboard.
This endpoint is free — checking your balance does not consume any credits. For how credits are charged per endpoint, see Pricing.

​
Endpoint

GET https://api.crustdata.com/user/credits
It takes no query parameters or request body. Authenticate with your API key in the Authorization header.

​
Example request

curl --request GET \
  --url https://api.crustdata.com/user/credits \
  --header 'authorization: Bearer YOUR_API_KEY'

​
Response fields

FieldTypeDescription
creditsnumberRemaining API credits on your account. May be fractional for some plans.

​
Errors

StatusBodyCause
401{ "message": "Missing API key in request" }No Authorization header.
401{ "message": "Invalid API key in request" }Authorization header carries an invalid key.

​
Account credits

For more than the bare balance, use the account credits endpoint. It adds your recurring credit grant: how many credits you receive each cycle, how often, when the next refresh lands, and whether unused credits roll over. 
GET https://api.crustdata.com/account/credits
Like /user/credits, it is free, takes no parameters, and is rate limited to 300 requests per minute. 
curl --request GET \
  --url https://api.crustdata.com/account/credits \
  --header 'authorization: Bearer YOUR_API_KEY'

​
Response fields

FieldTypeDescription
account.creditsnumberRemaining API credits on your account — the shared pool all your API keys draw from.
account.recurring_creditsnumberCredits granted each billing cycle. 0 if your plan has no recurring grant.
account.recurring_credits_frequencystring | nullGrant cadence (for example monthly). null if no recurring grant.
account.recurring_credits_refresh_datestring | nullISO timestamp of the next grant refresh. null if no recurring grant.
account.credit_rolloverbooleanWhether unused recurring credits carry into the next cycle.

​
What to do next

  • Understand charges — see Pricing for per-endpoint credit costs.
  • Avoid 429s — review Rate limits when polling at scale.
  • Check API access — see Permissions for which endpoints and fields your account can use.