Skip to content
Longport WhaleLongport Whale
Client Limit

Client Batch Apply Trade Limit

Called from a row action or the floating bulk-action bar; only the supplied values differ. This activates or deactivates live trading limits and is a high-risk operation.

Request parameters

  • Required: list (Batch target limit config list), is_apply (Apply flag)
  • Optional: audit_frontend_resource (Frontend audit log metadata)
  • See each field for its format, allowed values, default behavior, and business meaning.

Risk notice

This operation may affect live business data or asset state. Verify the target records, amounts, quantities, and operation type before calling it.

Result

On success, the endpoint completes the described business operation. See the 200 response schema for returned data.

POSThttps://b-api.lbkrs.com/risk_limit/v1/client/batch_apply

Production: https://b-api.lbkrs.com · Test: https://b-api.longbridge.xyz

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_risk_limit_config.risk_limit_config_client_update

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

Request body application/json

listarray<string>required

Batch target limit config list. Field meanings per item: counter_id (counter number), aaid (customer account ID, the key field for the customer dimension), code (security code, usually empty), trader/trader_name (trader ID/name), client_group/client_group_name (client category/group ID/name), stock_group (stock-group ID).

is_applybooleanrequired

Apply flag. true activates records in bulk; false deactivates them. The UI passes the negated current value from Activate or Deactivate.

true · Batch Activatefalse · Batch Deactivate

audit_frontend_resourceobject

Frontend audit log metadata. Audit-only metadata, not a business parameter. $action is add when activating or delete when deactivating; $behavior contains the localized audit description.

Responses

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

On success data is an empty object.

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