Usage Stats

View API usage statistics for your account, including request counts, rate limit status, and active streams.


GET /api/v1/account/usage

This endpoint replaces the former /me/usage endpoint. The response format has been updated to use the standard v1 envelope.

AuthenticationPermalink for this section

Requires API key. Available to all tiers.

Example RequestsPermalink for this section

cURL


curl -X GET "https://api.sharpapi.io/api/v1/account/usage" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript


const response = await fetch(
  'https://api.sharpapi.io/api/v1/account/usage',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);
const { data } = await response.json();
 
console.log(`Today: ${data.requests.today} requests`);
console.log(`This week: ${data.requests.this_week} requests`);
console.log(`This month: ${data.requests.this_month} requests`);
console.log(`Rate limit remaining: ${data.requests.limit.remaining}/${data.requests.limit.per_minute} per minute`);
console.log(`Active streams: ${data.streams.active}/${data.streams.max}`);

Python


import requests
 
response = requests.get(
    'https://api.sharpapi.io/api/v1/account/usage',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
usage = response.json()['data']
 
print(f"Today: {usage['requests']['today']} requests")
print(f"This month: {usage['requests']['this_month']} requests")
print(f"Rate limit: {usage['requests']['limit']['remaining']}/{usage['requests']['limit']['per_minute']} per minute")
print(f"Active streams: {usage['streams']['active']}/{usage['streams']['max']}")

ResponsePermalink for this section

Success (200)Permalink for this section


{
  "data": {
    "requests": {
      "today": 342,
      "this_week": 2105,
      "this_month": 14523,
      "limit": {
        "per_minute": 300,
        "remaining": 287,
        "resets_at": "2026-02-08T14:45:00.000Z"
      }
    },
    "streams": {
      "active": 2,
      "max": 10
    },
    "period": {
      "start": "2026-02-01T00:00:00.000Z",
      "end": "2026-02-28T23:59:59.000Z"
    }
  },
  "meta": {
    "updated_at": "2026-02-08T14:50:00.123Z"
  }
}

Response HeadersPermalink for this section


X-RateLimit-Limit: 300
X-RateLimit-Remaining: 287
X-RateLimit-Reset: 1707401400
X-Data-Delay: 0
X-Request-Id: req_usage789abc

Error ResponsesPermalink for this section

401 Unauthorized


{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key",
    "docs": "https://docs.sharpapi.io/en/authentication"
  }
}

Response FieldsPermalink for this section

Requests ObjectPermalink for this section

Field	Type	Description
`today`	number	Total API requests today (UTC)
`this_week`	number	Total API requests this week
`this_month`	number	Total API requests this billing month

Requests Limit ObjectPermalink for this section

Field	Type	Description
`per_minute`	number	Maximum API requests allowed per minute
`remaining`	number	Requests remaining in the current rate limit window
`resets_at`	string	ISO 8601 timestamp when the rate limit window resets

Streams ObjectPermalink for this section

Field	Type	Description
`active`	number	Number of currently active SSE/WebSocket streams
`max`	number	Maximum concurrent streams allowed (0 if streaming not enabled)

Period ObjectPermalink for this section

Field	Type	Description
`start`	string	ISO 8601 start of the current billing month
`end`	string	ISO 8601 end of the current billing month

Use CasesPermalink for this section

Monitor Rate Limit UsagePermalink for this section


import requests
 
response = requests.get(
    'https://api.sharpapi.io/api/v1/account/usage',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)
usage = response.json()['data']
 
limit = usage['requests']['limit']
usage_pct = (1 - limit['remaining'] / limit['per_minute']) * 100
print(f"Rate limit usage: {usage_pct:.1f}%")
print(f"Resets at: {limit['resets_at']}")

Check Stream AvailabilityPermalink for this section


const { data } = await fetch(
  'https://api.sharpapi.io/api/v1/account/usage',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
).then(r => r.json());
 
if (data.streams.active >= data.streams.max) {
  console.log('All stream slots in use — close a stream before opening a new one');
} else {
  console.log(`${data.streams.max - data.streams.active} stream slots available`);
}

Account Info - Account details, tier, and features
API Key Management - Manage your API keys
Pricing - Compare tier limits