GunSpec

Usage

What this key has spent against its plan. The same counters the rate limiter and the daily cap read, so a client can slow itself down before a 429 rather than after one. A 304 costs a rate-limit slot but no daily quota, which is why a caching client sees this number rise more slowly than its request count.

Auth RequiredExplorer+

client.usage.get()

Current usage for the calling key.

get(params?: UsageParams): Promise<APIResponse<UsageStats>>
GET/v1/me/usage

Explorer+

  • stringheaderrequired

    Your API key. Authorization: Bearer <key> is accepted in its place.

  • string

    Billing month to report on, formatted YYYY-MM

    Example
  • integer

    Trailing window in days, as an alternative to month

    Example

application/json

  • object

    The response payload.

  • object

    Totals for the reported period, meaning the current billing month, or the trailing window when days is given.

  • integer

    Requests counted in the reported period across every key on the account.

  • integer

    Requests your plan allows in the period.

  • number

    Share of records, 0 to 100.

  • string

    When the counter next returns to zero, ISO 8601 UTC.

  • object

    Usage through the hosted MCP server, a subset of the requests above.

  • integer

    Calls made through the MCP server in the reported month. Already counted in currentMonth.used, never on top of it.

  • integer

    MCP calls today (UTC) across every key on the account.

  • integer

    MCP calls one key may make per UTC day on this plan. The limit applies to each key separately.

  • object | null

    The key nearest its daily MCP limit, or null when no key has made an MCP call today.

  • string

    When the daily MCP counters return to zero: the next midnight UTC.

  • object[]

    Requests per day over the reported period, oldest first. Days with no traffic are omitted.

  • string

    The day, YYYY-MM-DD in UTC.

  • integer

    How many records fall in this bucket.

  • integer

    Of count, the requests made through the MCP server.

  • object[]

    Requests per API key over the reported period.

  • string

    Id of the API key. The key itself is never returned.

  • string

    The label you gave the key.

  • integer

    How many records fall in this bucket.

  • integer

    Of count, the requests made through the MCP server.

  • integer

    MCP calls this key made today (UTC), the figure its daily MCP limit is held against.

  • integer

    How many API keys the account holds.

  • object

    The allowances of the plan the account is on.

  • string

    Display name, as the maker writes it.

  • integer

    Monthly request allowance on this plan.

  • integer

    Requests per minute this plan allows.

  • integer

    MCP calls each key may make per UTC day on this plan.

  • 400VALIDATION_ERRORValidation error
  • 401UNAUTHORIZEDAPI key required
  • 403FORBIDDENValid key, not permitted
  • 429RATE_LIMITEDRate limit exceeded
  • 500INTERNAL_ERRORUnexpected server error

Full rate limits

Minimum tier
Explorer+
Monthly quota
200/mo
Rate limit
10/min
Daily cap
50

Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.