Query calendar management configuration

Query the clearing calendar configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains the trading and accounting calendars — market, trade date, ledger date and date type; used by clearing and accounting to determine trading/ledger days and special dates.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

POSThttps://b-api.lbkrs.com/v1/datasets/clearing_calendars

Authorization

AuthorizationstringheaderRequired

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

Permission

clearing.clearing_calendar_view

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

Request body application/json

filtersobject

Child attributes

marketstring

Values are dynamically queried from clearing_markets_all (not fixed); fetch them live via GET /v1/datasets/refs/clearing_markets.

trade_dateobject

Range filter; both bounds are optional (omit a bound to leave that side unbounded).

Child attributes

gtestring

ltestring

typestring

Filters results by Type. Values come from a backend data dictionary.

Allowed values: 1 Normal Day (Trade&Settlement), 2 Non-Settlement Day (Trade Only), 3 Non-Trading Day (Settlement Only), 4 Typhoon, 5 Holidays

Values

1: Normal Day (Trade&Settlement)
2: Non-Settlement Day (Trade Only)
3: Non-Trading Day (Settlement Only)
4: Typhoon
5: Holidays

pageinteger

page_sizeinteger

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

trade_datestring

Trade date. Returned value: Calendar date, formatted YYYYMMDD.

typestring

Type. Returned value: Date type (display value; the raw code is in the matching _val field); values match the filters.type request parameter.

type_valstring

Raw value behind field type. The type field returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired

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/v1/datasets/clearing_calendars' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "trade_date": "20250101",
        "type": "1",
        "type_val": "1"
      }
    ],
    "total": 1
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/clearing_calendars/download

clearing.clearing_calendar_view

Export options Export records Download result