Daytrade Margin Call

Returns real-time risk alert (Margin Call) records for the intraday financing business, used to monitor margin call and liquidation risk for intraday financing clients.

Request parameters

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

Business notes

Each record represents one intraday financing alert and carries the same fields as the real-time alert records: client and account number, alert type and status, triggered / turned-to-forceselling / due times, margin call amount, equity loan value, initial/maintenance/forceselling margin requirements, net asset ratio, total holding market value, closable counters, and whether 0DTE options are held, tailored to the intraday financing scenario.

It supports filtering by client, holdings, 0DTE options, holding type, and other dimensions.

Returns

On success, returns the matching records with pagination info. See the response definition for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_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

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.

alert_datestring

Triggered At. Filters results by Triggered At.

alert_typestring

Alert Type. Filters results by Alert Type.

Allowed values: MarginCall Margin Call, ForceCall Forceselling Call, OverFinancingCall Over Financing Call (Financing > Credit Limit), OptionExerciseCall Option Exercise Force Call, OptionExerciseMarginCall Option Exercise Margin Call, DebtMarginCall Debt MarginCall, OptionOverFinancingCall Option Over Financing Call (Financing > Credit Limit)

Values

MarginCall: Margin Call
ForceCall: Forceselling Call
OverFinancingCall: Over Financing Call (Financing > Credit Limit)
OptionExerciseCall: Option Exercise Force Call
OptionExerciseMarginCall: Option Exercise Margin Call
DebtMarginCall: Debt MarginCall
OptionOverFinancingCall: Option Over Financing Call (Financing > Credit Limit)

statusstring

Status. Filters results by Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 0 Pending, 1 Follow Up - Pending, 2 Completed - Deposit Fund, 3 Completed - Sell Stocks, 4 Contacted/ Notified, 5 Auto Ended/Completed (System), 6 Ended/Completed (User), 7 Auto Forcesold (Sytem) - Pending, 8 Auto Forcesold (Sytem) - Failed, 10 Exception, 11 Auto Forcesold (Sytem) - Time-out Error

Values

0: Pending
1: Follow Up - Pending
2: Completed - Deposit Fund
3: Completed - Sell Stocks
4: Contacted/ Notified
5: Auto Ended/Completed (System)
6: Ended/Completed (User)
7: Auto Forcesold (Sytem) - Pending
8: Auto Forcesold (Sytem) - Failed
10: Exception
11: Auto Forcesold (Sytem) - Time-out Error

counter_id_list_v2string

Holdings. Filters results by Holdings.

is_contain_doom_optionstring

Include 0DTR Option?. Filters results by Include 0DTR Option?.

Allowed values: true Yes, false No

Values

true: Yes
false: No

counter_id_liststring

Exclude Underlying Shares. Filters results by Exclude Underlying Shares.

counter_id_list_v3string

Product. Filters results by Product.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: HK HK - Stock, US US - Stock, OP/US US - Option, SG SG - Stock

Values

HK: HK - Stock
US: US - Stock
OP/US: US - Option
SG: SG - Stock

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 Intraday Margin Risk Alert Record 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

idstring

Alert ID. Returned value: Unique identifier of the current record.

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.

alert_typestring

Alert Type. Returned value: Alert Type.

alert_type_valstring

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

no_doom_margin_statusstring

Alert Type (Excl. 0DTE Options). Returned value: Alert Type (Excl. 0DTE Options).

no_doom_margin_status_valstring

Alert Type (Excl. 0DTE Options) (raw value). Raw value of no_doom_margin_status. The no_doom_margin_status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

statusstring

Status. Returned value: Status.

status_valstring

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

reasonstring

Identified Root Cause. Returned value: Identified Root Cause.

reason_valstring

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

commentstring

Remarks. Returned value: Remarks.

alert_datestring

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

m_m_trans_into_force_timestring

Turned To Forceselling At. Returned value: Turned To Forceselling At. The date or time format follows the value returned by the API.

end_datestring

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

triggered_timestring

Triggered Duration (H). Returned value: Triggered Duration (H). The date or time format follows the value returned by the API.

currencystring

Currency. Returned value: Currency.

net_asset_ratiostring

Net Asset Ratio. Returned value: Net Asset Ratio.

option_holding_mm_marginstring

MM (Option %). Returned value: MM (Option %).

is_contain_doom_optionstring

Include 0DTR Option?. Returned value: Indicates whether include 0dtr option?.

is_contain_doom_option_valstring

Include 0DTR Option? (raw value). Raw value of is_contain_doom_option. The is_contain_doom_option field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

warning_valuestring

Margin Call Amount. Returned value: Margin Call Amount.

position_valuestring

MV of Holdings. Returned value: MV of Holdings.

total_assetstring

Equity Balance. Returned value: Equity Balance.

im_marginstring

IM Requirement. Returned value: IM Requirement.

mm_marginstring

MM Requirement. Returned value: MM Requirement.

ignore_im_marginstring

IM w/o 0DTE Option. Returned value: IM w/o 0DTE Option.

ignore_mm_marginstring

MM w/o 0DTE Option. Returned value: MM w/o 0DTE Option.

ignore_fm_marginstring

FM w/o 0DTE Option. Returned value: FM w/o 0DTE Option.

fm_marginstring

FM Requirement. Returned value: FM Requirement.

counter_id_liststring

Available Counters List. Returned value: Available Counters List.

account_classstring

A/C Type. Returned value: A/C Type.

account_class_valstring

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

sub_account_countstring

No of Sub-Accounts. Returned value: No of Sub-Accounts.

namestring

Credit Group. Returned value: Credit Group.

real_namestring

Name. Returned value: Name.

long_suspend_market_valuestring

MV of Suspended Shares. Returned value: MV of Suspended Shares.

net_current_assetsstring

Net Current Assets. Returned value: Net Current Assets.

triggered_daystring

Day Count. Returned value: Day Count.

navmmstring

Net Asset/MM. Returned value: Net Asset/MM.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/risk_intraday_financing_alert_logs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "833538",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "alert_type": "Forceselling Call",
        "alert_type_val": "ForceCall",
        "no_doom_margin_status": "Force Call",
        "no_doom_margin_status_val": "2",
        "status": "Pending",
        "status_val": "0",
        "reason": "Other",
        "reason_val": "0",
        "comment": " ",
        "alert_date": "1781263172",
        "m_m_trans_into_force_time": "1781263267",
        "end_date": "1781293800",
        "triggered_time": "812.00",
        "currency": "HKD",
        "net_asset_ratio": "0.00",
        "option_holding_mm_margin": "0.00%",
        "is_contain_doom_option": "No",
        "is_contain_doom_option_val": "false",
        "warning_value": "12,000.000",
        "position_value": "0.00",
        "total_asset": "-12,000.00",
        "im_margin": "0.00",
        "mm_margin": "0.00",
        "ignore_im_margin": "0.00",
        "ignore_mm_margin": "0.00",
        "ignore_fm_margin": "0.00",
        "fm_margin": "0.00",
        "counter_id_list": "",
        "account_class": "Individiual",
        "account_class_val": "0",
        "sub_account_count": "0",
        "name": "",
        "real_name": "Zhang San",
        "long_suspend_market_value": "0",
        "net_current_assets": "-12,000.00",
        "triggered_day": "35",
        "navmm": "0"
      }
    ],
    "total": 141
  }
}