Get Markets Calendar Init Status

Queries the clearing-calendar initialization status of each market for a given year, used to determine whether a market's calendar has already been initialized for that year.

Request parameters

Required: year (Year)
Optional: markets (Markets); omit to query all markets.

Result

Returns the calendar initialization status for each market in the given year. See the 200 response schema for the returned data structure.

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

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

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 below, 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 frontend receives this endpoint's response as any and does not read fixed business fields at the call site. Only the general response structure (code, message, data) is declared here; the concrete fields inside data are unverified.

Standard response envelopecodemessagedata

dataobjectdata structure

dataarray<object>

Child attributes

marketstring

is_initboolean

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": {}
}