Skip to main content
POST
List calendar events

Restrictions

Usage

  • year defaults to the current year; without month the whole year is returned, and day requires month.
  • items merges the calendar’s own events (cale.* IDs), one generated non_work.YYYYMMDD entry per non-working weekday when workdays is set, and the events of the linked holiday calendars; total counts all of them.
  • days gives the resolved state of every day in the scope.
  • Only personal calendars (cal_id starting with cal.) are supported; other IDs return InvalidParameter.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Calendar event list request. When day > 0 month must also be specified. month and day accept 0 to mean "not filtered".

cal_id
string
required

Calendar ID, obtained from POST /calendar/list. A calendar listed there with kind = exchange.holiday is accepted too, so a trading calendar can be read directly.

year
integer

Year. Defaults to the current year when omitted.

Required range: x >= 2023
month
integer

Month (1-12). 0 means no month filter.

Required range: 0 <= x <= 12
day
integer

Day (1-31). 0 means no day filter.

Required range: 0 <= x <= 31

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Calendar event list response.