Utils - Credits Usage of current account
curl --request GET \
--url https://public-api.birdeye.so/utils/v1/credits \
--header 'X-API-KEY: <api-key>'import requests
url = "https://public-api.birdeye.so/utils/v1/credits"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://public-api.birdeye.so/utils/v1/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"start_time": 1758367608,
"end_time": 1760959608,
"usage": {
"total": 1176300,
"api": 1162912,
"ws": 13388
},
"remaining": {
"api": 1498837088,
"ws": 49986612,
"total": 1548823700
},
"overage_usage": {
"api": 0,
"ws": 0,
"total": 0
},
"overage_cost": {
"api": 0,
"ws": 0,
"total": 0
}
},
"success": true
}{
"success": false,
"message": "Bad request"
}{
"success": false,
"message": "Unauthorized"
}{
"success": false,
"message": "Access Denied"
}{
"success": false,
"message": "Too many requests"
}{
"success": false,
"message": "Internal Server Error"
}Search & Utils
Utils - Credits Usage of current account
Retrieve credit usage of current account.
GET
/
utils
/
v1
/
credits
Utils - Credits Usage of current account
curl --request GET \
--url https://public-api.birdeye.so/utils/v1/credits \
--header 'X-API-KEY: <api-key>'import requests
url = "https://public-api.birdeye.so/utils/v1/credits"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://public-api.birdeye.so/utils/v1/credits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"start_time": 1758367608,
"end_time": 1760959608,
"usage": {
"total": 1176300,
"api": 1162912,
"ws": 13388
},
"remaining": {
"api": 1498837088,
"ws": 49986612,
"total": 1548823700
},
"overage_usage": {
"api": 0,
"ws": 0,
"total": 0
},
"overage_cost": {
"api": 0,
"ws": 0,
"total": 0
}
},
"success": true
}{
"success": false,
"message": "Bad request"
}{
"success": false,
"message": "Unauthorized"
}{
"success": false,
"message": "Access Denied"
}{
"success": false,
"message": "Too many requests"
}{
"success": false,
"message": "Internal Server Error"
}- Usage Note
- Accessibility
- Chain Supported
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 ⚙️
Compute Unit ⚙️
- This endpoint consumes
1 CUper request.
Use Cases 💡
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 🛠️
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 ✅
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.
Authorizations
API key for authentication
Query Parameters
Specify the start time using unix timestamps in seconds
Required range:
0 <= x <= 10000000000Specify the end time using unix timestamps in seconds
Required range:
0 <= x <= 10000000000Was this page helpful?

