Clearing - Bond List

Query the list of clearing bond instruments, used to maintain and reconcile each bond's interest-payment and period information for clearing.

Request parameters

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

Business notes

The data comes from bond master information joined with its interest-rate and payment records; each record represents one bond included in clearing.

Each record carries the internal security code (counter_id), bond name, issue date, the nearest payment date pending update, the final payment date, whether the period schedule is complete, status, and the last update time and operator.

The period and payment-date information drives bond interest clearing; changes to bond information typically require approval, and each record links to an approval ticket ID. Use ticket_id to filter bonds that have an outstanding approval ticket.

Returns

On success, returns the list of matching records with pagination. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_clearing.clearing_busin_steps

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

counter_idstring

Filters results by Counter ID. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

ticket_idstring

Filters results by Pending Approvals.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - Clearing Bond List records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

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

counter_idstring

Returned value: Counter ID.

counter_id_valstring

Raw value of counter_id. The counter_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

stock_namestring

Returned value: Name.

ipo_datestring

Returned value: Issue Date. The date or time format follows the value returned by the API.

upcoming_datestring

Returned value: Upcoming Payment Date. The date or time format follows the value returned by the API.

final_payment_datestring

Returned value: Final Payment Date. The date or time format follows the value returned by the API.

period_completestring

Returned value: Period Complete.

period_complete_valstring

Raw value of period_complete. The period_complete field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

statusstring

Returned value: State.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

Returned value: Updated At. The date or time format follows the value returned by the API.

operatorstring

Returned value: Last Updated.

operator_valstring

Raw value of operator. The operator field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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_bonds' \
  --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",
        "counter_id": "ST/SZ/000555",
        "counter_id_val": "",
        "stock_name": "Digital China Information",
        "ipo_date": "2025-03-05",
        "upcoming_date": "2025-03-13",
        "final_payment_date": "2025-03-27",
        "period_complete": "Complete",
        "period_complete_val": "0",
        "status": "Effective",
        "status_val": "2",
        "updated_at": "2026-07-02 21:22:28",
        "operator": "Zhang San",
        "operator_val": "user@example.com"
      }
    ],
    "total": 172
  }
}