Get Markets Calendar Init Status

Queries the clearing-calendar initialization status of each market for a given year, so callers can tell whether a market's calendar has been initialized for that year.

Request parameters

Required: year.
Optional: markets (market list); when omitted, all markets are queried.
See the field definitions for format and business meaning.

Returns

On success, returns the calendar initialization status of each market for that year. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/clearing/get_markets_calendar_init_status

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

clearing.clearing_calendar_operation

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

yearintegerrequired

The year to query. This field is required.

marketsarray<string>

List of market codes to query. Omit to query all markets.

Responses

HTTP 200The request was processed successfully. The business result is in data.

Standard response envelopecodemessagedata

dataobjectdata structure

dataarray<object>

Calendar initialization status per market.

Child attributes

marketstring

Market code, such as HK or US.

is_initboolean

Whether the calendar for the year has been initialized.

HTTP 400Bad request. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.

Standard response envelopecodemessagedata

dataobjectdata structure

No nested fields

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/clearing/get_markets_calendar_init_status' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "year": 2024,
  "markets": [
    "HK",
    "US"
  ]
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "data": [
      {
        "market": "HK",
        "is_init": true
      }
    ]
  }
}