Skip to content
Longport WhaleLongport Whale
Difference (Holding)

Clearing - Position Reconciliation Differences

Query the difference details found in custodian position reconciliation, used to check each quantity mismatch between local holdings and custodian (counterparty) holdings.

Request parameters

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

Business notes

Each record corresponds to one security's position difference under a reconciliation task, carrying the task ID, execution date (system date), ledger date, market, reconciliation channel, ISIN, security code, and the local and counterparty sub-accounts, quantities, and quantity difference.

The reconciliation result tag distinguishes whether a position exists on only one side or the quantities differ on both, helping locate deviations between clearing holdings and custodian holdings.

Returns

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

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

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
task_idstring

Filters results by Task ID.

ledger_datestring

Filters results by Executive Date(Sys Date).

trade_ledger_datestring

Filters results by Ledger Date.

marketstring

Filters results by Market.

Values are dynamic. Call GET /v1/datasets/refs/clearing_config_markets to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

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 Reconciliation Difference Details 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.

task_idstring

Returned value: Task ID.

ledger_datestring

Returned value: Execution Date (System Date). The date or time format follows the value returned by the API.

trade_ledger_datestring

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

marketstring

Returned value: Market.

custodian_codestring

Returned value: Reconciliation Channel (Holdings).

isinstring

Returned value: ISIN.

counter_idstring

Returned value: Counter ID.

clearing_positionstring

Returned value: Local Stock Account.

other_positionstring

Returned value: Custodian Stock Account.

clearing_quantitystring

Returned value: Quantity (Local).

other_quantitystring

Returned value: Quantity (Broker).

result_tagstring

Returned value: Result Tag.

result_tag_valstring

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

detailstring

Returned value: Difference (Qty).

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