← Back to schema index

SpeiCalendarResponse

Response from `GET /v1/public/spei-calendar/{year}`. A single resource with the SPEI non-business days of the year and its source, and in `meta.covered_years` the years that have a calendar. A year without a calendar responds `404`, not this body.

Properties

FieldTypeDescription
dataobjectMain response payload. Shape varies by endpoint (object, array, or JSON:API envelope with `type`, `id`, `attributes`).
type*stringJSON:API resource type. Always `spei_calendar`.
id*stringCalendar year (four digits).
attributes*objectData of the year's calendar.
year*integerCalendar year (four digits). Same value as `id`.
non_business_days*arrayNon-business days that fall from Monday to Friday (`YYYY-MM-DD`), from lowest to highest. Saturdays and Sundays are also non-business days and are not repeated here.
source*objectOfficial provision the calendar comes from.
issuer*stringAcronym of the authority that issues the provision, for example `CNBV`.
published_in*stringAcronym of the official gazette that published the provision, for example `DOF`.
published_on*string (date)Publication date of the provision (`YYYY-MM-DD`).
title*stringOfficial title of the provision, in Spanish.
metaobjectResponse metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
versionstringAPI version that processed the request.
api_versionstringAPI route prefix version (e.g. `v1`).
request_idstringUnique request identifier (hex).
datetimeobjectCompanion 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.
timezone*stringAlways `UTC`: The canonical timezone for every datetime field in the body.
format*stringAlways `ISO 8601`: Explicit `Z` suffix on every datetime.
linksobjectPagination or related links, present only when the endpoint returns a paginated collection.

Used in operations

  • GET /v1/public/spei-calendar/{year}