Skip to content
Longport WhaleLongport Whale
Option Securities Recovery

Options Close Position Actions in List

Query the Options Close Position Actions in List.

GEThttps://b-api.longbridge.xyz/v1/datasets/risk_option_force_orders

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

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

Query parameters

filtersobject

Filters

Child attributes
aaidstring

A/C No.

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