Skip to content
Order Page Setup

Check Security Tradability

Checks whether a security can be traded in the current account when the user switches or searches for a security on the order page, and returns a prompt and guidance buttons. When is_alert is true, show msg and buttons in a dialog instead of opening order entry directly; if buttons is empty, treat the security as not tradable. When is_alert is false, the order page can open; if is_toast is also true, show msg as a brief toast.

WhaleCore's orderService() wraps this endpoint as the typed method checkTradability. If you use WhaleCore, prefer that method.

GEThttps://api.lbkrs.com/v5/orders/tradable

Parameters

counter_idstringqueryRequired

Security ID (counter_id), for example ST/US/AAPL or ST/HK/700

Responses

HTTP 200The request succeeded. The response body contains the result of the “Check Security Tradability” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
counter_idstring

Security ID

is_cnconnectboolean

Whether the security is traded through China Connect

is_alertboolean

Whether to show a dialog and block direct order entry

is_toastboolean

When order entry is allowed, whether to show msg as a toast

msgstring

Prompt text

buttonsarray<object>

Guidance buttons in the dialog

Child attributes
namestring

Button label

linkstring

Target link, used when type is 2

typeinteger

Action on tap:

  • 0 - Close the dialog without entering order entry
  • 1 - Open the order page for this security
  • 2 - Open the page that link points to
Values
0
1
2
directioninteger

Order direction when type is 1:

  • 0 - Not restricted
  • 1 - Buy only
  • 2 - Sell only
Values
0
1
2
support_regular_saving_planboolean

Whether the security supports recurring investment plans

Whale Docs