Skip to main content
GET
/
v1
/
usage
Get Usage Stats
curl --request GET \
  --url https://api.shoal.xyz/v1/usage \
  --header 'Authorization: Bearer <token>'
Returns your API key’s request counts and monthly credit consumption. Use this to monitor how close you are to your credit limit, track usage trends, or build self-budgeting logic into your integration. This endpoint costs 0 credits — call it as often as you need.

​
Query Parameters

None. Usage is determined by the API key in your Authorization header.

​
Request

cURL
curl -X GET "https://api.shoal.xyz/v1/usage" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response (200)

{
  "data": {
    "today": 42,
    "thisWeek": 310,
    "thisMonth": 1205
  }
}
FieldDescription
todayRequests made since midnight UTC today
thisWeekRequests made since the start of the current week
thisMonthRequests made since the start of the current month

​
Credit Cost

0 credits — checking your own usage is always free. Use this endpoint to self-budget before making batch requests.