Skip to content
Longport WhaleLongport Whale
Transaction Summary

Clearing - Position Transaction Summary

Query the summary of custodian holding changes for clearing, used at day-end to reconcile total position changes by business and security.

Request parameters

  • Combine business filters through filters (see the filter field notes below for the optional fields), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data is grouped by ledger date, market, custodian, sub-position, business code, and security code; each record gives the total change quantity plus the Street, Nominee, and Own change subtotals for that combination.

  • Filter by ledger date, business code, market, custodian, sub-position, internal security code, or security code.

Unlike the change detail, this summary drops the individual client, making it convenient to reconcile overall position changes by business and security.

Returns

On success, returns the matching record list with pagination. See the response schema for column meanings.

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

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
ledger_dateobject

Filters results by Ledger Date.

Child attributes
gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

biz_codestring

Filters results by Biz Code.

marketstring

Filters results by Market.

custodian_name_searchstring

Filters results by Custodian.

sub_position_nostring

Filters results by Stock Account.

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.

codestring

Filters results by Counter ID.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Clearing - Position Transaction Summary 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
ledger_datestring

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

marketstring

Returned value: Market.

custodian_namestring

Returned value: Custodian Name.

sub_position_nostring

Returned value: Stock Account.

counter_idstring

Returned value: Counter ID.

biz_codestring

Returned value: Biz Code.

biz_code_valstring

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

quantitystring

Returned value: Quantity.

street_quantitystring

Returned value: Street Quantity.

nominee_quantitystring

Returned value: Nominee Quantity.

own_quantitystring

Returned value: Own Quantity.

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