Skip to content
Longport WhaleLongport Whale
Option Securities Recovery

Option Covered-Stock Margin Call Detail

Returns the margin-call detail for the stock underlying an option covered-call recall.

Request parameters

  • Required: record_id (margin-call record ID). Use the id of a record returned by risk_option_stock_margin_call_records.
  • The admin console queries this endpoint by record_id only.

Returns

On success, returns the option-recall stock margin-call detail. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/risk_monitoring/option_stock_margin_call_detail

Authorization

AuthorizationstringheaderRequired

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

Parameters

record_idstringRequired

Margin-call record ID. The id of an option covered-stock margin-call record returned by risk_option_stock_margin_call_records.

aaidstring

A/C No.

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.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure
margin_call_infoobject

Basic information of the margin call record.

Child attributes
member_namestring

Client name.

display_nostring

Securities account number, such as H00000000.

end_datestring

Deadline in YYYY-MM-DD format.

account_channelstring

Counter channel, such as lb.

symbolstring

Symbol. May be an empty string.

stock_counter_idstring

Code of the stock to be called, such as ST/US/AAPL.

warning_quantitystring

Quantity to be called (numeric string).

currencystring
aaidstring

Internal securities account ID aaid.

warning_typestring

Alert type code, such as ExerciseStockMarginCall.

holding_stock_quantitystring

Underlying stock holding quantity. May be an empty string.

holding_stock_frozen_quantitystring

Underlying stock frozen quantity. May be an empty string.

option_holding_covered_need_qtystring

Quantity required to cover option holdings. May be an empty string.

option_open_order_covered_need_qtystring

Quantity required to cover open option orders. May be an empty string.

position_info_listarray<object>

Related option position list.

Child attributes
option_counter_idstring

Option code.

stock_counter_idstring

Underlying stock code.

attributestring

Position attribute, such as Long Put or Short Call.

directionstring

Call/put flag, such as C or P.

quantitystring

Position quantity; negative for short positions.

available_quantitystring

Available quantity; negative for short positions.

min_close_quantitystring

Minimum quantity to close.

end_datestring

Expiry date in YYYY-MM-DD format.

strike_pricestring

Strike price.

option_pricestring

Option price.

last_pricestring

Last price of the underlying stock.

ratio_of_in_the_moneystring

In-the-money ratio (percentage string).

option_in_money_typeinteger

Moneyness type code (integer).

exercise_need_stock_quantitystring

Stock quantity required for exercise.

stock_available_quantitystring

Available quantity of the underlying stock.

frozen_statusstring

Frozen status (display text), such as 未冻结.

settlement_channelstring

Settlement channel, such as ib_hk.

symbolstring

Symbol. May be an empty string.

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