User Holding Details

Returns the position details for the user associated with a margin-call alert record.

Request parameters

Required: risk_monitoring_log_id (risk-alert record ID), aaid (securities account)
See the field definitions for each field's format, allowed values, and business meaning.

Returns

On success, returns the user's position details for the alert record. See the response definition for field meanings.

POSThttps://b-api.lbkrs.com/v1/risk_monitoring/holding_datail

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_detailed

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

Request body application/json

risk_monitoring_log_idintegerrequired

Risk Monitoring Log ID

aaidstringrequired

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

dataobject

Holding details.

Child attributes

position_info_listarray<object>

Stock position list.

Child attributes

counter_idstring

Security code, such as ST/HK/700.

quantitystring

Position quantity.

available_quantitystring

Available quantity.

last_pricestring

Last price.

position_valuestring

Position market value in the security currency.

mm_margin_percentagestring

Maintenance margin ratio (percentage value).

need_close_position_valuestring

Market value to be closed.

min_need_close_position_qtystring

Minimum quantity to close.

counter_namestring

Security name.

marketstring

Market, such as HK or US.

currencystring

Trading currency of the security.

is_ipo_stockstring

IPO stock flag (string), such as 0.

position_value_hkdstring

Position market value in HKD.

ratestring

Ratio (percentage string, such as 50%).

pending_order_amountstring

Pending order amount.

mm_marginstring

Maintenance margin amount.

per_reduce_valstring

per_reduce_val amount in the security currency.

per_reduce_val_hkdstring

per_reduce_val amount in HKD.

account_channel_currencystring

Counter channel currency.

need_close_position_value_currencystring

Converted market value to be closed.

mcm_marginstring

Margin call margin ratio (percentage value).

option_info_listarray<object>

Option position list.

Child attributes

option_idstring

Option code, such as OP/US/AAPL261023C200000.

underlying_counter_idstring

Underlying security code.

PCStatusstring

Call/put flag, such as C.

position_sidestring

Position side, such as LONG.

holding_quantitystring

Holding quantity.

avail_holding_quantitystring

Available holding quantity.

end_timestring

Expiry date in YYYY-MM-DD format.

exercise_valuestring

Strike price.

market_pricestring

Option market price.

stock_pricestring

Underlying stock price.

market_valuestring

Position market value.

is_exercise_prepareboolean

Exercise preparation flag.

min_need_close_position_qtystring

Minimum quantity to close.

mm_marginstring

Maintenance margin amount.

mm_margin_percentagestring

Maintenance margin ratio (percentage value).

pending_order_amountstring

Pending order amount.

per_reduce_valstring

per_reduce_val amount in the security currency.

per_reduce_val_hkdstring

per_reduce_val amount in HKD.

per_release_valuestring

per_release_value amount.

account_channel_currencystring

Counter channel currency.

settlement_channelstring

Settlement channel, such as ib_hk.

short_position_info_listarray<object>

Short position list. May be an empty array.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/risk_monitoring/holding_datail' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "risk_monitoring_log_id": 1,
  "aaid": "H00000000"
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "data": {
      "position_info_list": [
        {
          "counter_id": "ST/HK/700",
          "quantity": "100",
          "available_quantity": "100",
          "last_price": "100.00",
          "position_value": "10,000.00",
          "mm_margin_percentage": "50.00",
          "need_close_position_value": "10,000.00",
          "min_need_close_position_qty": "100",
          "counter_name": "腾讯控股",
          "market": "HK",
          "currency": "HKD",
          "is_ipo_stock": "0",
          "position_value_hkd": "10,000.00",
          "rate": "50%",
          "pending_order_amount": "0.0000",
          "mm_margin": "5,000.00",
          "per_reduce_val": "100.00",
          "per_reduce_val_hkd": "100.00",
          "account_channel_currency": "HKD",
          "need_close_position_value_currency": "10,000.00",
          "mcm_margin": "70.00"
        }
      ],
      "option_info_list": [
        {
          "option_id": "OP/US/AAPL261023C200000",
          "underlying_counter_id": "ST/US/AAPL",
          "PCStatus": "C",
          "position_side": "LONG",
          "holding_quantity": "1",
          "avail_holding_quantity": "1.00",
          "end_time": "2026-01-01",
          "exercise_value": "200.00",
          "market_price": "1.00",
          "stock_price": "200.00",
          "market_value": "1,000.00",
          "is_exercise_prepare": false,
          "min_need_close_position_qty": "1",
          "mm_margin": "1,000.00",
          "mm_margin_percentage": "100.00",
          "pending_order_amount": "0.0000",
          "per_reduce_val": "100.00",
          "per_reduce_val_hkd": "100.00",
          "per_release_value": "100.00",
          "account_channel_currency": "HKD",
          "settlement_channel": "ib_hk"
        }
      ],
      "short_position_info_list": []
    }
  }
}