get
https://public-api.birdeye.so/utils/v1/credits
Retrieve credit usage of current account.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Current-cycle or bounded credit-usage report for the authenticated account.
- Maximum
time_fromtotime_tospan is one year. - If
time_fromandtime_toare omitted, the endpoint returns the current billing-cycle view. - If the requested range falls outside the current cycle,
remaining,overage_usage, andoverage_costreturnnull.
- Standard
- Lite
- Starter
- Premium
- Business
- Enterprise
All chains ⛓️ ✨
Compute Unit ⚙️
- This endpoint consumes
1 CUper request.
Use Cases 💡
- Monitor current credit consumption for one API account.
- Build internal usage dashboards and overage alerts.
- Reconcile product usage with subscription or billing state.
How to Use 🛠️
- Call without time parameters for the current cycle.
- Add
time_fromandtime_towhen you need a bounded historical slice within the supported range.
Best Practices ✅
- Poll lightly and cache for ops dashboards; usage does not need market-data refresh frequency.
- Treat
nulloverage or remaining fields as “outside current cycle,” not as zero.