GunSpec

Usage

What this key has spent against its plan. The same counters the rate limiter and the caps read. daily is the limit that is enforced per key, held against each key on its own: limitPerKey, what the busiest key has left, and resetsAt, the next midnight UTC. currentMonth is the plan's allowance, enforced for the whole account: calls served this month (used), limit, remaining and resetsAt, midnight UTC on the 1st. To slow down before a 429 you do not need to call this: every response already carries what is left of the day and the month as response.rateLimit (dailyRemaining, dailyReset, monthlyRemaining, monthlyReset). Use this to reconcile and to see every key at once, and remember it is itself a request. A 304 costs a rate-limit slot but spends neither the day nor the month, which is why a caching client sees these numbers rise more slowly than its request count.

Authentifizierung erforderlichExplorer+

client.usage.get()

Current usage for the calling key.

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

Explorer+

  • stringHeadererforderlich

    Ihr API-Schlüssel. Authorization: Bearer <key> wird ebenfalls akzeptiert.

  • string

    Billing month to report on, formatted YYYY-MM

    Beispiel
  • integer

    Trailing window in days, as an alternative to month

    Beispiel

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 served in the reported period across every key on the account. Calls a limit refused with a 429 are not counted: they spent nothing, and this is the figure the monthly allowance is enforced against.

  • integer

    Requests your plan allows in the period. Enforced: once used reaches it every call is refused with MONTHLY_CAP_EXCEEDED until resetsAt.

  • integer

    Requests left in the period, never below zero.

  • number

    Share of records, 0 to 100.

  • string

    When the monthly counter returns to zero: midnight UTC on the first of the next month, for every plan. The same instant as X-Monthly-Reset.

  • object

    What is left of today, against the limit that is enforced. Each key is counted and limited on its own.

  • integer | null

    Requests one key may make per UTC day on this plan. The limit applies to each key separately, which is why there is no account total to compare it with. Null when the plan has no daily ceiling.

  • integer

    Requests made today (UTC) across every key on the account. Not comparable with limitPerKey unless the account has one key: each key is held to the limit on its own.

  • object | null

    The key nearest its daily limit, or null when no key has made a request today.

  • string

    When every daily counter returns to zero: the next midnight UTC. The same instant as X-Daily-Reset.

  • 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

    Your standing. Experience is earned per call and weighted by what the call is: resolving a name, asking what fits a firearm or comparing two records is worth several times a page of a list, because the point is integration depth rather than traffic. Earned by an SDK, the MCP server, a script or a request tool; a browser earns nothing, since the reference has a Try It button and a page left open should not outrank a production service. A 304 earns nothing, on the same reasoning that it spends no quota, and a call that failed earns nothing either.

  • integer

    Experience earned across every key on the account, for its whole life.

  • integer

    Experience earned today (UTC).

  • integer

    The most one key can earn in a UTC day. A ceiling rather than a target: reaching it every day is not how the levels are meant to be climbed.

  • integer

    Your level, derived from xp alone. Nothing else moves it.

  • integer

    The experience this level began at.

  • integer

    The experience the next level begins at.

  • integer

    Consecutive days you have called the API, counting today. A day you did not call breaks it, though yesterday still counts as unbroken so a timezone does not cost you a streak. Reported, never rewarded: no experience is paid for showing up.

  • integer

    Days you have called the API at all, over the last two years.

  • integer

    Documented operations you have called at least once. Counted from the request log by the nightly job, so an operation you called for the first time today appears tomorrow.

  • integer

    Documented operations there are to call, counted from this document rather than written down, so it cannot fall behind a route added today.

  • object

    Calls to endpoints above your plan, attached to the account so every key draws on the same balance. Every new account starts with a one-time grant covering any endpoint up to Studio, and the team can give more. A call spent this way is served exactly as the endpoint's own plan would be (full fields, that plan's paging depth), is marked with an X-Endpoint-Credit: spent header, and still counts against your plan's per-minute and daily limits. A call that fails, or answers 304, is given back.

  • integer

    Calls left across every credit that can still be spent.

  • object[]

    Every credit the account has had, newest first, spent ones included.

  • 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

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

  • integer | null

    Requests this key has left today, never below zero. Null when the plan has no daily ceiling.

  • 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, enforced for the whole account.

  • integer | null

    Requests each key may make per UTC day on this plan: the limit that is enforced. Null when the plan has no daily ceiling.

  • 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

Alle Anfragelimits

Mindeststufe
Explorer+
Monatskontingent
200/mo
Anfragerate
10/min
Tageslimit
50

Die Werte gelten für die Mindeststufe dieses Endpunkts. Höhere Stufen erhöhen alle Limits.