Skip to content
Longport WhaleLongport Whale
Contract

Contract

Query virtual-asset clearing contracts, used for clearing, billing, and settlement reconciliation of virtual-asset trades.

Request parameters

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

Business notes

Each record is a clearing contract tied to a single virtual-asset execution, joined with its corresponding charge record.

A record carries the contract number, trade date and ledger date, securities account and sub-account, settlement channel, market, security code, trade direction, quantity and amount, currency, plus fee fields such as calculated, receivable, charged, and deduction amounts.

The status reflects the clearing lifecycle: initialized → to be charged → to be settled → equity settled (T+M) → settlement completed (T+N).

Typically used to trace clearing and fee collection for a trade by client, market, security, trade date, or status.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

lb_hk_clearing.billing_va_contracts

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

filtersobject

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

Child attributes
nostring

Contract No. Filters results by Contract No.

aaidstring

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

contract.trade_dateobject

Trade Date. Filters results by Trade Date.

Child attributes
gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

marketstring

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

counter_idstring

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

directionstring

Trade Direction. Filters results by Trade Direction.

Allowed values: 1 Buy, 2 Sell

Values
1
Buy
2
Sell
settlement_channelstring

Settlement Channel. Filters results by Settlement Channel.

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

statestring

Status. Filters results by Status.

Allowed values: 2 To Be Calculated, 3 To Be Charged, 4 To Be Settled, 5 Settlement Completed, 6 Equity settled, 1 Init, -1

Values
2
To Be Calculated
3
To Be Charged
4
To Be Settled
5
Settlement Completed
6
Equity settled
1
Init
-1
--
currencystring

Currency. Filters results by Currency.

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

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Virtual Asset Contract records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

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

nostring

Contract No. Returned value: Contract No.

ledger_datestring

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

trade_datestring

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

aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

settlement_accountstring

Sub Account. Returned value: Sub Account.

settlement_channelstring

Settlement Channel. Returned value: Settlement Channel.

settlement_channel_valstring

Settlement Channel (raw value). Raw value of settlement_channel. The settlement_channel field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

marketstring

Market. Returned value: Market.

counter_idstring

Counter ID. Returned value: Counter ID.

directionstring

Trade Direction. Returned value: Trade Direction.

direction_valstring

Trade Direction (raw value). Raw value of direction. The direction field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

trade_quantitystring

Trade Qty. Returned value: Trade Qty.

trade_amountstring

Trade Amt. Returned value: Trade Amt.

currencystring

Currency. Returned value: Currency.

bill_amountstring

Fee After Discount. Returned value: Fee After Discount.

calculate_out_amountstring

Calculated Amt. Returned value: Calculated Amt.

deduction_amountstring

Discount Fee. Returned value: Discount Fee.

receivable_amountstring

Fee Receivable. Returned value: Fee Receivable.

statestring

Status. Returned value: Status.

state_valstring

Status (raw value). Raw value of state. The state field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

Updated At. Returned value: Updated At. The date or time format follows the value returned by the API.

totalintegerrequired

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