← Back to schema index

ApiUsage

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

Properties

Field Type Description
requests_today integer Total API requests on the current calendar day (UTC).
requests_month integer Total API requests in the current calendar month (UTC).
quota object Active plan validation quota status.
plan_slug string Active plan identifier.
plan_name string Human-readable name of the active plan.
limit integer Validations included in the plan per calendar month.
used integer Validations consumed in the current month.
remaining integer Validations remaining in the current month.
resets_at string (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_requests array User's most recent API requests (reverse chronological order).
banxico_status string Current 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_history array Validations consumed per calendar month (history).

Used in operations

  • GET /v1/api/usage