Skip to content
Longport WhaleLongport Whale
Option Securities Recovery

Options Stock Collection Alert Record

Query option stock recovery (buy-in) alert records, used by risk control to follow up on stock that clients must make up after option exercise settlement.

Request parameters

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

Business notes

  • The data comes from option stock recovery alerts and only includes records that still require handling (completed or closed ones are excluded).

  • Each record carries the alert number, counter channel, client account, alert type and reason, alert date and deadline, the stock to recover with its counter_id, the quantity to be made up, and the current order status.

  • It lets risk control monitor each client's outstanding stock recovery and follow up by status.

Returns

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

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

Authorization

AuthorizationstringheaderRequired

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

Permission

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

stock_counter_idstring

Stock Code. Filters results by Stock Code.

statusstring

Status. Filters results by Status.

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
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 Options Stock Collection 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.

account_channelstring

Account Channel. Returned value: Account Channel.

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.

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.

end_datestring

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

stock_namestring

Stock Name. Returned value: Stock Name.

counter_idstring

Stock Code. Returned value: Stock Code.

counter_id_valstring

Stock Code (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.

warning_quantitystring

Qty To Be Recovered. Returned value: Qty To Be Recovered.

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.

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