← Back to schema index

ApiUsage

API usage statistics, validation quota, and Banxico status for the account.

Properties

FieldTypeDescription
requests_todayintegerNumber of the user's API key requests on the current calendar day (UTC).
requests_monthintegerNumber of the user's API key requests in the current calendar month (UTC).
quotaobjectCurrent validation quota state: limit, usage, balance, and reset.
plan_slugstringUnique, human-readable plan identifier. It corresponds to the user's active plan.
plan_namestringPlan name shown in the interfaces.
limitintegerEffective validation limit for the current cycle.
usedintegerValidations consumed in the current cycle.
remainingintegerValidations available in the current cycle (`max(0, limit - used)`).
resets_atstring (date-time)ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `*_at`, `*_end`, `*_start`, and `*_date` fields follow this format. `meta.datetime` describes the same contract in the response.
recent_requestsarrayUser's 15 most recent API key requests, from most to least recent.
banxico_statusstringCurrent Banxico CEP service status — `operational`: Available and responding normally; `degraded`: Available but with partial errors; `down`: Completely unavailable (all recent records are errors); `unknown`: Insufficient recent data to determine status.
usage_historyarrayValidations consumed per calendar month (history).

Used in operations

  • GET /v1/api/usage