← Back to schema index

ApiUsage

API usage statistics and Banxico service status. Returned by `GET /v1/api/usage`.

Properties

FieldTypeDescription
requests_todayintegerTotal API requests on the current calendar day (UTC).
requests_monthintegerTotal API requests in the current calendar month (UTC).
quotaobjectValidation quota state for the plan in force: how many it includes, how many have been used, how many remain, and when the count resets.
plan_slugstringActive plan identifier.
plan_namestringHuman-readable name of the active plan.
limitintegerValidations included in the plan per calendar month.
usedintegerValidations consumed in the current month.
remainingintegerValidations remaining in the current month.
resets_atstring (date-time)ISO 8601 timestamp in UTC with explicit `Z` suffix. Example: `"2026-05-01T05:14:38Z"`. Every datetime field uses this shape. The descriptor at `meta.datetime` makes the contract runtime-assertable.
recent_requestsarrayUser's most recent API requests (reverse chronological order).
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