Skip to content
Longport WhaleLongport Whale
Auto Forceselling Switch

Update Covered Option Close-Out Rule

Update the covered-option collection sub-rule for automatic forced liquidation, controlling whether covered-option close-out is enabled, whether short options are skipped, and the trigger time.

Request parameters

  • Required: is_enable_covered_opt_close_out (whether covered-option close-out is enabled), is_skip_short_option (whether to skip short options).
  • Optional: covered_opt_close_out_trigger_time (close-out trigger time), audit_frontend_resource (caller-provided audit context).
  • See the individual field descriptions for each field's format, allowed values, and business meaning.

Risk warning

This changes a real automatic forced-liquidation configuration and may trigger auto-liquidation of customer option positions; the risk is very high. Confirm every switch and the trigger time carefully before calling.

Result

On success, the covered-option close-out rule is updated; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/covered_opt_close_out/rules/update

Authorization

AuthorizationstringheaderRequired

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

Request body application/json

is_enable_covered_opt_close_outbooleanrequired

Boolean flag for enable covered option close-out. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
covered_opt_close_out_trigger_timestring

In HH:mm format; required when the rule is enabled.

is_skip_short_optionbooleanrequired

Boolean flag for skip short option. this field is required.

Boolean values:

  • true - The condition applies
  • false - The condition does not apply
audit_frontend_resourceobject

Records a snapshot of the rule before modification (whether option covered close-out is enabled, the trigger time, and whether selling options is skipped) before submission, for before-and-after comparison in the approval ticket.

Responses

HTTP 200The request was processed successfully. The response data does not contain additional business fields.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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