Skip to content
Longport WhaleLongport Whale
Option Securities Recovery

Options Close Position Actions in List

Query the list of option forced-liquidation orders that are still in progress, used by risk control to track option close-out orders that have been placed but not yet completed.

Request parameters

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

Business notes

  • The data comes from option close-out orders and only includes in-progress orders that have not been canceled, rejected, expired, or fully filled.

  • Each record carries the order time, the option counter_id and its underlying, the option direction (Long Call, Long Put, Short Call, Short Put), the submitted price and quantity, the order number, the order source, and the order status.

  • It lets risk control monitor the execution progress of forced-liquidation orders.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.opt_stock_margin_call_records_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
aaidstring

A/C No.

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.

underlying_counter_idstring

Stock Code

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

Submitted At

counter_idstring

Option Code

submitted_pricestring

Submitted Price

submitted_quantitystring

Submitted Qty

statestring

Order Status

state_valstring

Order Status (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.

order_idstring

Order ID

op_entrust_waystring

Order Channel

op_entrust_way_valstring

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

attributestring

Trade Direction

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