Skip to content
Longport WhaleLongport Whale
Position Summary

Clearing - Position Summary

Query the clearing position summary. 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_custodian_position_summary

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

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.

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

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.

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