Skip to content

Usage

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

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

Response fields

  • Name
    plan
    Type
    object
    Description

    Your current plan details.

  • Name
    plan.tier
    Type
    string
    Description

    Plan tier. One of free, analyst, pro, enterprise.

  • Name
    plan.rpm
    Type
    integer
    Description

    Requests per minute allowed on your plan.

  • Name
    plan.monthly_limit
    Type
    integer
    Description

    Total monthly request quota for your plan.

  • Name
    rate_limit
    Type
    object
    Description

    Current rate limit configuration.

  • Name
    rate_limit.requests_per_minute
    Type
    integer
    Description

    Requests per minute allowed. Same as plan.rpm.

  • Name
    quota
    Type
    object
    Description

    Monthly quota status.

  • Name
    quota.used
    Type
    integer
    Description

    Number of requests consumed in the current billing period.

  • Name
    quota.limit
    Type
    integer
    Description

    Monthly quota ceiling.

  • Name
    quota.remaining
    Type
    integer
    Description

    Requests remaining before hitting the monthly cap.

  • Name
    quota.resets_at
    Type
    string
    Description

    ISO 8601 timestamp when the monthly counter resets.

  • Name
    last_24h
    Type
    object
    Description

    Request breakdown for the trailing 24-hour window.

  • Name
    last_24h.total_requests
    Type
    integer
    Description

    Total requests made in the last 24 hours.

  • Name
    last_24h.by_endpoint
    Type
    object
    Description

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

Request

GET
/v1/usage
curl -G https://www.sharpe.ai/api/v1/usage \
  -H "Authorization: Bearer sk_live_your_key_here"
{
  "data": {
    "plan": {
      "tier": "analyst",
      "rpm": 500,
      "monthly_limit": 500000
    },
    "rate_limit": {
      "requests_per_minute": 500
    },
    "quota": {
      "used": 12480,
      "limit": 500000,
      "remaining": 487520,
      "resets_at": "2026-04-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"
  }
}

Was this page helpful?