v1

latestOpenAPI 3.0.32026-08-04850206.9 KB

Key usage & quota

Usage introspection for the calling key's owner: the Data API plan, its monthly limit, used and remaining (always matching the X-Quota-* headers), the current period window, and per-endpoint / per-token breakdowns. Embed-widget usage has its own plan and pool — it never appears here.

get/api/v1/usage

Response

Example response

{
  "data": {
    "plan": "free",
    "limit": 10000,
    "used": 29,
    "remaining": 9971,
    "period_start": "2026-06-15",
    "period_end": "2026-07-15T00:00:00+00:00",
    "burst_per_minute": 60,
    "endpoints": [
      {
        "endpoint": "GET api/v1/prices",
        "requests": 18
      },
      {
        "endpoint": "GET api/v1/global",
        "requests": 11
      }
    ],
    "tokens": [
      {
        "id": 12,
        "name": "production",
        "kind": "data-api",
        "requests": 29,
        "last_used_at": "2026-07-02T21:14:09+00:00",
        "revoked": false
      }
    ]
  },
  "meta": {
    "note": "Endpoint and token breakdowns are flushed from the buffer every minute and can trail `used` slightly."
  }
}