Skip to content
Longport WhaleLongport Whale
Margin Call

Preview Short-Sell Liquidation Push Message

Previews the content of the short-sell position liquidation push notification.

Request parameters

  • Required: aaid (securities account ID), counter_id (security), push_msg_type (1 App message, 2 Email message).
  • The frontend calls this once per selected message type.
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Generates a preview of the short-sell liquidation notification before it is actually sent, so it can be confirmed first.

Returns

On success, returns the preview content of the short-sell liquidation push notification. See the response definition for field meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

margin_call.short_sell_msg

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

Request body application/json

aaidstringrequired

Securities account ID (aaid) of the short-sell position, taken from the position row. Pass the internal numeric ID, not the securities account number account_no (such as H00000000) or the customer ID member_id.

counter_idstringrequired

Security counter ID of the short-sell position, e.g. ST/HK/700, taken from the position row.

push_msg_typeintegerrequired

Push message type.

Allowed values: 1 App message, 2 Email message

Values
1
App Message
2
Email Message

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

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