Skip to content
Client Option Margin Factor

Create Client Stock Option Margin

Create a stock-option margin-factor record for a specific client, defining the upper and lower option margin bounds for a given underlying.

Request parameters

  • Required: aaid, counter_id. Usually provide the upper and lower bounds of all three factors.
  • See the field descriptions for the format, value range, and business meaning of each field.

Business notes

A record typically carries the client, stock code, and the upper and lower bounds of the initial, maintenance, and forced-liquidation margin factors, used in margin calculations for the client's option positions.

Risk warning

This operation adds a client-level stock-option margin configuration and directly affects the margin requirements on the client's option positions. Confirm the target client and parameters before calling.

Result

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

POSThttps://b-api.lbkrs.com/risk/v1/account_stock_opt_margin_ratio/create

Authorization

AuthorizationstringheaderRequired

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

Permission

credit_management.option_stock_margin_ratio_query

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

Request body application/json

aaidintegerrequired

Internal securities account ID aaid (numeric), not the account number account_no.

counter_idstringrequired

Security code in the form {type}/{market}/{code}, e.g. ST/US/AAPL.

max_im_factornumber

Upper bound of the initial margin factor.

min_im_factornumber

Lower bound of the initial margin factor.

max_mm_factornumber

Upper bound of the maintenance margin factor.

min_mm_factornumber

Lower bound of the maintenance margin factor.

max_fm_factornumber

Upper bound of the forced-liquidation factor.

min_fm_factornumber

Lower bound of the forced-liquidation factor.

remarkstring

Remark.

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