Skip to content
Longport WhaleLongport Whale
Client Option Margin Factor

Client Option Margin Factor

Query client-level option margin-factor configuration, used by risk control to set option margin upper and lower bounds for a specific client on a specific underlying.

Request parameters

  • Combine business filters through filters (optional fields are listed in the filters field notes below), and use page, page_size, and orderBy for pagination and sorting.

Business notes

  • The data comes from client-level option margin-factor configuration; each record maps one client (aaid) and one underlying security to a set of option margin parameters.

  • Each record carries security details (counter_id, stock name, market) plus the option margin upper and lower bounds, each expressed as IM, MM, and FM factors (max_im_factor, max_mm_factor, max_fm_factor, min_im_factor, min_mm_factor, min_fm_factor).

  • It also includes op_user, remark, and the created and updated timestamps. This is a per-client override layered on top of the global option margin factors.

Returns

On success, returns the matching record list with pagination. See the response definition for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_member_option_margin_ratios

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

filtersobject

Filters. Combines business filters. Omit a filter field to disable that filter.

Child attributes
counter_idstring

Counter id. Filters results by Counter id. Format is {type}/{market}/{code}, for example, stock ST/HK/700 or ST/US/AAPL, and option OP/US/AAPL270319C320000.

aaidstring

Client. Filters results by Client.

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.

max_im_factorobject

IM Max. Filters results by IM Max.

Child attributes
gtenumber

Greater Than or Equal. Inclusive lower bound of the filter range.

ltenumber

Less Than or Equal. Inclusive upper bound of the filter range.

min_im_factorobject

IM Min. Filters results by IM Min.

Child attributes
gtenumber

Greater Than or Equal. Inclusive lower bound of the filter range.

ltenumber

Less Than or Equal. Inclusive upper bound of the filter range.

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated User Options Margin Factor records together with pagination metadata such as the page number, page size, and total record count.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List. Returned value: List of list.

Child attributes
aaidstring

A/C No.. Returned value: A/C No..

aaid_valstring

A/C No. (raw value). Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

counter_idstring

Counter id. Returned value: Counter id.

counter_id_valstring

Counter id (raw value). Raw value of counter_id. The counter_id field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

short_name_localesstring

Stock name. Returned value: Stock name.

marketstring

Market. Returned value: Market.

market_valstring

Market (raw value). Raw value of market. The market field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

maxstring

Option Max Margin Ratio. Returned value: Option Max Margin Ratio.

minstring

Option Min Margin Ratio. Returned value: Option Min Margin Ratio.

updated_atstring

Update time. Returned value: Update time. The date or time format follows the value returned by the API.

created_atstring

Create time. Returned value: Create time. The date or time format follows the value returned by the API.

op_userstring

Operator. Returned value: Operator.

remarkstring

Remark. Returned value: Remark.

totalintegerrequired

Total. Returned value: Total number of matching records, used for pagination.

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