Skip to content
Longport WhaleLongport Whale
Custodian Query

Clearing - Position List

Query custodian holding position details for clearing, used at day-end to reconcile each client's holdings across custodians and sub-positions.

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 broken down by client, market, security, custodian, and sub-position; each record carries the ledger date, asset ID, client ID, securities account number, client name, market, custodian and custodian ID, sub-position, internal security code, and the Street, Nominee, and Own quantities plus their closing total (only rows with a non-zero holding are kept).

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

Use it to reconcile the distribution of custodial holdings and as the basis for position moves and transfers.

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_positions

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.

aaidstring

Filters results by Client.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

marketstring

Filters results by Market.

custodian_namestring

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 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: Records matching the query conditions.

Child attributes
idstring

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

ledger_datestring

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

member_idstring

Returned value: Member Id.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Client Name.

marketstring

Returned value: Market.

custodian_namestring

Returned value: Custodian Name.

sub_position_nostring

Returned value: Stock Account.

counter_idstring

Returned value: Counter 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