Skip to main content
GET
Utils - Credits Usage of current account

Current-cycle or bounded credit-usage report for the authenticated account.

  • Maximum time_from to time_to span is one year.
  • If time_from and time_to are omitted, the endpoint returns the current billing-cycle view.
  • If the requested range falls outside the current cycle, remaining, overage_usage, and overage_cost return null.
  • This endpoint consumes 1 CU per request.
  • Monitor current credit consumption for one API account.
  • Build internal usage dashboards and overage alerts.
  • Reconcile product usage with subscription or billing state.
  • Call without time parameters for the current cycle.
  • Add time_from and time_to when you need a bounded historical slice within the supported range.
  • Poll lightly and cache for ops dashboards; usage does not need market-data refresh frequency.
  • Treat null overage or remaining fields as “outside current cycle,” not as zero.

Authorizations

X-API-KEY
string
header
required

API key for authentication

Query Parameters

time_from
integer

Specify the start time using unix timestamps in seconds

Required range: 0 <= x <= 10000000000
time_to
integer

Specify the end time using unix timestamps in seconds

Required range: 0 <= x <= 10000000000

Response

JSON object containing the credits usage

success
boolean
required

Whether the request completed successfully.

data
object
required

Credit usage and remaining balance for the current account.