/api/v1/usageGETReturns request totals for the authenticated account over a UTC calendar window. Pass
days from 1 to 90 (default 30). Totals split successful (2xx) and error (4xx and 5xx) responses. daily lists each UTC date that had traffic. by_endpoint lists matched route templates such as /api/v1/markets/{id}, ordered by request count. Rate-limit refusals are not counted. Requires a bearer token.Authorization
bearerAuth *Bearer <token>
Session token from the app, or an API key (the
ak_ prefix), sent as a Bearer token or an ?api_key= query parameter.. Token in: headerQuery Parameters
days?integer
Number of UTC calendar days to include, ending today. Default 30. Must be between 1 and 90.
Default:
30Min: 1Max: 90Response
200 · Account API usage for the requested window
days *integer
Resolved look-back window in UTC days.
from *string (date)
Inclusive window start,
YYYY-MM-DD (UTC).to *string (date)
Inclusive window end,
YYYY-MM-DD (UTC, today).total_requests *integer (int64)
Successful plus error requests in the window.
successful_requests *integer (int64)
2xx responses in the window.
error_requests *integer (int64)
4xx and 5xx responses in the window.
daily *object[]
Per-UTC-date totals, ascending. Dates with no traffic are omitted.
Show item properties
date *string (date)
UTC date,
YYYY-MM-DD.requests *integer (int64)
Successful plus error requests on this date.
successful *integer (int64)
2xx responses on this date.
errors *integer (int64)
4xx and 5xx responses on this date.
by_endpoint *object[]
Per-route totals, ordered by request count descending then route.
Show item properties
route *string
Matched route template, for example
/api/v1/markets/{id}.requests *integer (int64)
Requests to this route in the window.
400 · `days` is outside 1 to 90.
error?string
Stable, machine-readable code identifying the failure; branch on this rather than on
message. One of bad_request, unauthorized, forbidden, not_found, conflict, service_unavailable, upstream_error, service_error, or internal_error.message?string
Human-readable explanation, safe to show to a user. For client errors it names the specific problem; for server-side failures it is a generic notice and the underlying detail is deliberately withheld.
401 · Unauthorized
error?string
Human-readable reason the request was not authenticated or authorized, for example a missing or malformed
Authorization header, an invalid token, or a token lacking the required scope. This is free text whose wording can change, so branch on status (or the HTTP status code) instead of on this string.status?integer
The HTTP status code repeated in the body.
429 · The organization's minute or UTC-day request budget is exhausted, or the organization has reached its cap on requests running at the same time (`limit: "concurrency"`). Wait `Retry-After` seconds before retrying; for a concurrency 429, reduce parallelism.
error *"rate_limited"
Always
rate_limited. Branch on this to detect a throttled request.limit *"rpm" | "daily" | "concurrency"
Which limit was hit:
rpm for the per-minute cap, daily for the daily one, or concurrency for the cap on requests running at the same time.message *string
Human-readable explanation naming the limit that was exceeded.
upgrade_url?string (uri)
Page listing the plans and their request allowances, for buying a larger budget. Absent when no plan is available for purchase.