Skip to content
Longport WhaleLongport Whale
Forceselling Records

History Close Position Record

Returns historical orders generated by forced liquidation, covering batch forced close, forced close, and short-sell forced buy-in sources, used to review how risk-control liquidations were executed.

Request parameters

  • Combine business filters through filters (optional fields are listed in the filter field descriptions below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

Each record represents one liquidation order and carries the order time, order type and status, security code, submitted price and quantity, executed price and quantity, buy/sell direction, operator, and force-close type.

Records can be located by order ID or security code.

Returns

On success, returns the matching records with pagination info. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_query

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

Request body application/json

filtersobject

Filters

Child attributes
order_idstring

Order ID

counter_idstring

Counter ID. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
created_atstring

Created At

order_typestring

OrderType

order_type_valstring

OrderType (raw value). Raw value behind field order_type: order_type returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

order_idstring

Order ID

order_id_valstring

Order ID (raw value). Raw value behind field order_id: order_id returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

statestring

State

state_valstring

State (raw value). Raw value behind field state: state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

counter_idstring

Counter Id

submitted_pricestring

Submitted Price

submitted_quantitystring

Submitted Quantity

executed_pricestring

Executed Price

executed_quantitystring

Executed Quantity

actionstring

Action

action_valstring

Action (raw value). Raw value behind field action: action returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

op_userstring

Op User

force_typestring

Force Type

force_type_valstring

Force Type (raw value). Raw value behind field force_type: force_type returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

totalintegerrequired

Total

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