Skip to content
Longport WhaleLongport Whale
Auto Forceselling Switch

Modify Risk Monitoring Config

Modify the master switch for risk-monitoring alerts (automatic forced liquidation), enabling or disabling auto-liquidation per trade type and forced-liquidation type.

Request parameters

  • Required: trade_type (trade type), force_type (forced-liquidation type), is_enable (whether to enable).
  • Optional: 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 whether the real automatic forced-liquidation master switch is in effect, and may trigger or stop auto-liquidation of customer positions. Confirm the trade type and forced-liquidation type carefully before calling.

Result

On success, the auto-liquidation switch is updated; the resulting state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/modify_risk_monitoring_cfgs_v2

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_auto_batch_forccconfig

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

Request body application/json

trade_typestringrequired

Raw transaction-type enum value. When updating a configuration, pass through the value returned by the corresponding query API without translating it.

force_typestringrequired

Raw forced-liquidation-type enum value. When updating a configuration, pass through the value returned by the corresponding query API without translating it.

is_enablebooleanrequired

Send true when clicking "On", false when clicking "Off".

audit_frontend_resourceobject

An audit-trail field that records the complete record of the operated row along with $action=edit before submission, for display 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