Calendar

Get calendar by code

Returns details for a specific financial center calendar including weekend rules and metadata

get/api-regulated/v1/calendars/{calendarCode}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/calendars/{calendarCode}
  • Auth: HTTP bearer

Path parameters

calendarCodestring required

Calendar code (e.g., GBLO, USNY)

Response

Calendar found

calendarCodestring

Industry standard calendar codes

descriptionstring

Calendar description

isoCountryCodestring

ISO 3166-1 alpha-2 country code

isSundayWeekendboolean

Indicates if Sunday is a weekend for this calendar

isMondayWeekendboolean

Indicates if Monday is a weekend for this calendar

isTuesdayWeekendboolean

Indicates if Tuesday is a weekend for this calendar

isWednesdayWeekendboolean

Indicates if Wednesday is a weekend for this calendar

isThursdayWeekendboolean

Indicates if Thursday is a weekend for this calendar

isFridayWeekendboolean

Indicates if Friday is a weekend for this calendar

isSaturdayWeekendboolean

Indicates if Saturday is a weekend for this calendar

eventSequenceinteger

Event sequence number for event sourcing - globally monotonic across all entities

versionNumberinteger

Strictly monotonically increasing version number for this record

updatedBystring

Username of the person or entity that updated this record

updatedAtstring

Timestamp of the last update in UTC

createdAtstring

Timestamp of creation in UTC

Example response

{
  "calendarCode": "EUTA",
  "description": "TARGET2/Eurozone  ",
  "isoCountryCode": "GB or TARGET2",
  "isSundayWeekend": true,
  "isSaturdayWeekend": true,
  "eventSequence": 12345,
  "versionNumber": 1,
  "updatedBy": "jbloggs24",
  "updatedAt": "2024-10-18T12:30:40Z",
  "createdAt": "2024-10-18T12:30:40Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.