Skip to content
Order Page Setup

Check Multi-Leg Option Tradability

When the multi-leg option order page opens, or when the Client selects a multi-leg combination from positions to switch the order security, checks whether the combination can be traded in the current account and returns the prompt text and guidance buttons. The response has the same structure as Check Tradability: when is_alert is true, show msg and buttons in a dialog instead of opening the order page; if buttons is empty, treat the combination as not tradable. When is_alert is false, the order page can open; if is_toast is true, also show msg as a toast.

POSThttps://api.lbkrs.com/v1/orders/mleg/tradable

Request body application/json

counter_idstringrequired

Main security ID of the combination: the counter_id of the underlying stock, such as ST/US/AAPL

multiLegobjectrequired

Strategy and legs of the combination

Child attributes
strategystringrequired

Multi-leg strategy type:

  • 0 - Covered call
  • 1 - Covered put
  • 2 - Vertical call spread
  • 3 - Vertical put spread
  • 4 - Collar
  • 5 - Straddle
  • 6 - Strangle
  • 7 - Calendar call spread
  • 8 - Calendar put spread
Values
0
1
2
3
4
5
6
7
8
legsarray<object>required

Legs in the combination

Child attributes
counter_idstringrequired

Security ID of the leg: the option contract counter_id for an option leg, or the stock counter_id for a stock leg

Responses

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

Main security ID of the combination

is_alertboolean

Whether to show a dialog and block direct entry to the order page

is_toastboolean

When the order page can open, 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
Whale Docs