> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sharpe.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> Check your API plan details, rate limit status, monthly quota, and request breakdown for the last 24 hours.

The Usage endpoint returns your current API plan details, rate limit configuration, monthly quota status, and a per-endpoint request breakdown for the last 24 hours. Use it to monitor consumption, detect anomalies, and build internal dashboards.

***

## Get usage

`GET /v1/usage`

Returns usage information for the authenticated API key. No query parameters are required, because the key is identified from your `Authorization` header.

### Required scope

This endpoint requires the `usage:read` scope. API keys with the broad `read` scope also satisfy this route, because the v1 middleware treats `read` as a broad read permission for namespaced read scopes.

### Response fields

**plan** `object`

Your current plan details.

**plan.tier** `string`

Plan tier. One of `hobbyist`, `pro`, `commercial`, `enterprise`, or `analyst` (a legacy grant that is no longer sold).

**plan.rpm** `integer`

Requests per minute allowed on your plan.

**plan.monthly\_limit** `integer`

Total monthly request quota for your plan.

**rate\_limit** `object`

Current rate limit configuration.

**rate\_limit.requests\_per\_minute** `integer`

Requests per minute allowed. Same as `plan.rpm`.

**quota** `object`

Monthly quota status.

**quota.used** `integer`

Number of requests consumed in the current billing period.

**quota.limit** `integer`

Monthly quota ceiling.

**quota.remaining** `integer`

Requests remaining before hitting the monthly cap.

**quota.resets\_at** `string`

ISO 8601 timestamp when the monthly counter resets.

**last\_24h** `object`

Request breakdown for the trailing 24-hour window.

**last\_24h.total\_requests** `integer`

Total requests made in the last 24 hours.

> [!NOTE]
>
> The count is exact for every request in the window. Above 100,000 requests in 24 hours the breakdown covers the newest 100,000 and the response carries an `X-Data-Partial` header.

**last\_24h.by\_endpoint** `object`

Map of endpoint paths to usage stats. Each entry has `count`, `avg_response_ms`, and `errors`.

```bash cURL theme={null}
curl -G https://www.sharpe.ai/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_key_here"
```

```ts TypeScript theme={null}
const res = await fetch('https://www.sharpe.ai/api/v1/usage', {
  headers: { Authorization: 'Bearer sk_live_your_key_here' },
})
const { data } = await res.json()
```

```python Python theme={null}
import requests

resp = requests.get(
    "https://www.sharpe.ai/api/v1/usage",
    headers={"Authorization": "Bearer sk_live_your_key_here"},
)
data = resp.json()["data"]
```

```json Response theme={null}
{
  "data": {
    "plan": {
      "tier": "hobbyist",
      "rpm": 30,
      "monthly_limit": 50000
    },
    "rate_limit": {
      "requests_per_minute": 30
    },
    "quota": {
      "used": 2480,
      "limit": 50000,
      "remaining": 47520,
      "resets_at": "2026-12-01T00:00:00Z"
    },
    "last_24h": {
      "total_requests": 342,
      "by_endpoint": {
        "/api/v1/funding/rates": {
          "count": 120,
          "avg_response_ms": 85,
          "errors": 0
        },
        "/api/v1/news/feed": {
          "count": 98,
          "avg_response_ms": 142,
          "errors": 2
        },
        "/api/v1/price-prediction/data": {
          "count": 64,
          "avg_response_ms": 67,
          "errors": 0
        },
        "/api/v1/memecoins/data": {
          "count": 60,
          "avg_response_ms": 110,
          "errors": 1
        }
      }
    }
  },
  "meta": {
    "request_id": "req_abc123def456ghij",
    "timestamp": "2026-03-28T12:00:05Z",
    "elapsed_ms": 12
  }
}
```

[See error reference](https://docs.sharpe.ai/errors.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.