Skip to content
Longport WhaleLongport Whale
Shorted Stock Call Back

Short Stock Collection

Query short-position stock recovery alert records, used by risk control to monitor and follow up on stock make-up triggered by short-sell positions.

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

  • Each record carries the client account, counter_id, alert date, recovery status, the status of the notification sent to the client, and remarks.

  • It supports filtering by client, alert date, security, message status, and remark, where message status and remark accept multiple values.

  • It lets risk control send recovery notifications to the relevant clients in batches and track handling progress.

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/holding_short_stock_margin_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.

counter_idstring

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

message_statusstring

Message Status. Filters results by Message Status.

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

Allowed values: 0 Sent, 1 Not Yet Sent

Values
0
Sent
1
Not Yet Sent
remarkstring

Remark. Filters results by Remark.

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

Allowed values: 2 Insufficient short-selling pool, 1 Client's account doesn't support shortselling, 3 Day Trade Account, 4 Stocks cannot be sold short, 5 HKEX short selling prohibited

Values
2
Insufficient short-selling pool
1
Client's account doesn't support shortselling
3
Day Trade Account
4
Stocks cannot be sold short
5
HKEX short selling prohibited
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 Short Stock Collection 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.

real_namestring

Name. Returned value: Name.

origin_idstring

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

account_typestring

Account Type. Returned value: Account Type.

account_type_valstring

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

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.

message_statusstring

Message Status. Returned value: Message Status.

message_status_valstring

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

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.

stock_namestring

Stock Name. Returned value: Stock Name.

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.

remarkstring

Remarks. Returned value: Remarks.

remark_valstring

Remarks (raw value). Raw value of remark. The remark 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