GEThttps://api.veriko.mx/v1/status/banxico/timeseries

Banxico health time series (public view)

Audience
public
Auth
API key

Returns the historical operational status of the Banxico validation service, bucketed by time interval for the requested metric and window.

The bucket size depends on the window:

  • 1h: per minute.
  • 8h, 12h, 24h, and 7d: per hour.

It exposes the probe_latency and verdict metrics.

The response is cached 60 seconds on the client with Cache-Control, and that window is set at deploy time. Any authenticated user can query it, and no specific permission is required.

Parameters
ParameterInTypeRequiredDescription
metricquerystringoptional

Filter — Series to return. With probe_latency, each point is the average latency in milliseconds; with verdict, the bucket's Banxico verdict (its most recent), encoded as 0, 1, or 2.

Default: probe_latency

e.g. probe_latency
windowquerystringoptional

Filter — Window the series covers: 1h, 8h, 12h, 24h and 7d. 1h buckets by minute; the rest bucket by hour.

Default: 24h

e.g. 24h
Request
curl -X GET 'https://api.veriko.mx/v1/status/banxico/timeseries' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200BanxicoPublicTimeseriesResponse — Time-series data points.
FieldTypeDescription
dataobject

Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with type, id, attributes).

type*string

JSON:API resource type. Always banxico_public_timeseries.

e.g. banxico_public_timeseries
id*string

Identifier derived from the metric/window pair (<metric>_<window>).

e.g. probe_latency_24h
attributes*object

Time series of Banxico validation service health metrics, bucketed by time interval, as returned by GET /v1/status/banxico/timeseries.

metricstring

Reported metric — probe_latency: average health probe latency in milliseconds; verdict: the bucket's Banxico verdict, encoded as a number.

e.g. probe_latency
windowstring

Total time window covered by the series (1h, 8h, 12h, 24h, or 7d).

e.g. 24h
unitstring

Unit of the values — ms: milliseconds, when metric is probe_latency; verdict: a categorical code rather than a magnitude, when metric is verdict.

e.g. ms
bucket_size_minutesinteger

Size of each interval in minutes — 1: For the 1h window; 60: For the 8h, 12h, 24h and 7d windows.

e.g. 60
pointsarray

Data points in chronological order. Each point contains ts (bucket start timestamp) and value (number in ms for probe_latency; verdict code for verdict).

metaobject

Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.

versionstring

API version that processed the request.

e.g. 1.47.0
api_versionstring

API route prefix version (e.g. v1).

e.g. v1
request_idstring

Unique request identifier (hex).

e.g. a1b2c3d4e5f66f5e4d3c2b1a
datetimeobject

Companion descriptor present in the meta block of every response (and in the meta of outgoing webhook bodies). Lets clients assert the timezone contract without re-reading the spec.

e.g. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Always UTC: The canonical timezone for every datetime field in the body.

e.g. UTC
format*string

Always ISO 8601: Explicit Z suffix on every datetime.

e.g. ISO 8601
linksobject

Pagination or related links, present only when the endpoint returns a paginated collection.

Response status codesGET /v1/status/banxico/timeseries
StatusClassDescriptionBody
2002xxTime-series data points.BanxicoPublicTimeseriesResponse
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
Response headers200
HeaderTypeDescription
Cache-ControlstringPublic-view cache TTL (configurable; defaults to 60 s).
VarystringOrigin-based variation (CORS).
Errors from GET /v1/status/banxico/timeseries
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c