Account

Get your API usage

Returns request counts for your key against your plan allowance, what is left of today's daily limit and when it resets, and how many requests came through the hosted MCP server against its lower daily limit. Defaults to the current billing month; pass days for a trailing window instead.

You do not need this call to pace yourself: every /v1 response already carries X-Daily-Limit, X-Daily-Remaining and X-Daily-Reset for the key that made it, and this call is itself a request that counts. Use it to reconcile, and to see every key at once. daily is the limit that is enforced, counted per key; currentMonth is a running total for the billing period.

Requires an API key belonging to a user account. Acts on the calling account's own data.

get/v1/me/usage

Request

  • Base URL: https://api.gunspec.io
  • URL: https://api.gunspec.io/v1/me/usage
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

monthstring

Billing month to report on, formatted YYYY-MM

daysinteger

Trailing window in days, as an alternative to month

Response

Get your API usage

successboolean required

Always true on a successful response. Every error carries false and an error object instead.

Example response

{
  "success": true,
  "data": {
    "currentMonth": {
      "used": 1284,
      "limit": 25000,
      "remaining": 23716,
      "percentage": 5.1,
      "resetsAt": "2026-10-01T00:00:00.000Z"
    },
    "daily": {
      "limitPerKey": 5000,
      "usedToday": 1840,
      "busiestKeyToday": {
        "keyId": "key_01H8...",
        "keyName": "Production",
        "used": 1670,
        "remaining": 3330,
        "percentage": 33
      },
      "resetsAt": "2026-09-18T00:00:00.000Z"
    },
    "mcp": {
      "usedThisMonth": 312,
      "usedToday": 41,
      "dailyLimitPerKey": 2500,
      "busiestKeyToday": {
        "keyId": "key_01H8...",
        "keyName": "Claude Desktop",
        "used": 38,
        "percentage": 2
      },
      "resetsAt": "2026-09-18T00:00:00.000Z"
    },
    "progress": {
      "xp": 4210,
      "xpToday": 180,
      "dailyXpCap": 500,
      "level": 10,
      "levelStartsAt": 4050,
      "nextLevelAt": 5000,
      "streakDays": 12,
      "daysActive": 96,
      "operationsUsed": 31,
      "operationsAvailable": 145
    },
    "endpointCredits": {
      "remaining": 50,
      "credits": [
        {
          "id": "9f2c1e0a-5b7d-4c1e-8a3f-2d6b9e4c7a10",
          "source": "welcome",
          "operations": [
            "get /v1/firearms/{id}"
          ],
          "maxTier": "studio",
          "callsGranted": 50,
          "callsUsed": 12,
          "callsRemaining": 38,
          "expiresAt": "2026-12-31T00:00:00.000Z",
          "status": "active",
          "createdAt": "2026-09-10 08:30:00"
        }
      ]
    },
    "dailyBreakdown": [
      {
        "date": "2026-09-10",
        "count": 2187,
        "mcpCount": 64
      }
    ],
    "perKey": [
      {
        "keyId": "key_01H8...",
        "keyName": "Production",
        "count": 1603,
        "mcpCount": 210,
        "mcpToday": 38,
        "today": 1670,
        "remainingToday": 3330
      }
    ],
    "keyCount": 2,
    "tier": {
      "name": "Studio",
      "requestsPerMonth": 150000,
      "requestsPerDay": 10000,
      "rateLimit": 300,
      "mcpCallsPerDay": 2500
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.