Skip to content
Longport WhaleLongport Whale
Client Short Margin

Update Client Short Margin Ratio

Update a client's short-selling stock margin-ratio record, adjusting the short margin factors and expiry date for a given security.

Request parameters

  • Required: counter_id (security code), aaid (securities account), im_factor (initial margin ratio), mm_factor (maintenance margin ratio), fm_factor (forced-liquidation margin ratio), mcm_factor (Margin Call margin ratio), expire_at (expiry date).
  • See the field descriptions for the format, value range, and business meaning of each field.

Business notes

The initial, maintenance, forced-liquidation, and Margin Call ratios together determine the margin requirement and the warning and forced-liquidation trigger thresholds for the client's short positions. The configuration stops taking effect after expire_at.

Risk warning

This operation modifies a client-level short margin configuration and directly affects margin and forced-liquidation decisions on the client's short positions. Confirm the target record and parameters before calling.

Result

On success, the record is updated; subsequent state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/risk/v1/account_short_stock_margin_ratio/update

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_ratio.account_short_query

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

Request body application/json

counter_idstringrequired

Security code. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

aaidstringrequired

Securities account

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.

im_factornumberrequired

Initial margin ratio

mm_factornumberrequired

Maintenance margin ratio

fm_factornumberrequired

Force-liquidation margin ratio

mcm_factornumberrequired

Margin Call ratio

expire_atnumberrequired

Expiry date

remarkstring

Remark

position_sidenumber

Position side

short_sell_statusstring

short_sell_status

short_selling_open_qtynumber

short_selling_open_qty

short_selling_close_qtynumber

short_selling_close_qty

audit_frontend_resourceobject

audit_frontend_resource

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
ticket_idstring
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