Skip to content
Longport WhaleLongport Whale
Bond Interest Rate

Clearing - Bond List

Query the clearing bond list. Combine business filters through filters, and control pagination with page and page_size.

Response

On success, returns the matching list of records together with pagination information. See each field's documentation for the purpose, allowed values, and dynamic data source of every filter.

GEThttps://b-api.longbridge.xyz/v1/datasets/clearing_bonds

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

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 below, or the call will be rejected.

Query parameters

filtersobject

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

Child attributes
counter_idstring

Filters results by Counter ID.

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
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

Whale Docs