Usage Beta
GET /api/v1/usage
Your own quota, live — build a usage meter into your integration and stop guessing before you hit a 429. Scoped strictly to the account behind the key you present; it can never read another account's data. This endpoint takes no url.
Beta. This endpoint is new: it is live and safe to call on every plan, but its response shape may still change while we take feedback. Nothing here is scheduled for removal — if you depend on a particular field, tell us and we will keep it stable for you.
This call costs one request. Checking your usage counts against your usage. If you only need the current figures after doing real work, read the
usage object that every successful response already carries instead.Authentication
Send your API key as an X-API-Key header, or as a key query parameter. Available on every plan, including Free — plans differ only in requests per day. This call costs one request against your daily quota, which is shared across every key on the account. See Authentication.
Query parameters
| Name | Type | Description |
|---|---|---|
key optional | string | Your API key, if not sent as the X-API-Key header. |
Request
Response
200 · application/json
- {
- "tier": "free", "used": 42, "dailyLimit": 100, "remaining": 58,
- "note": "The daily limit is shared across every API key on the account, and resets at 00:00 UTC.",
- "usage": { "used": 42, "dailyLimit": 100, "tier": "free" }
- }
Response fields
| Field | Type | Description |
|---|---|---|
tier | string | The plan this key's account is on. |
used | integer | Requests used today, across every key on the account. |
dailyLimit | number | The account's daily allowance. |
remaining | integer | null | Requests left today. null on an unlimited plan. |
The daily limit is shared across every API key on the account and resets at 00:00 UTC — extra keys do not add quota. See API keys and Rate limits.
Errors
| Status | When |
|---|---|
401 | Missing or invalid API key. |
429 | Burst rate limit (60 req/10s per IP, 30 req/10s per key) or your daily quota. See Rate limits. |
Errors return { "error": "…" }; see Errors.