Skip to content
Order Page Setup

Get Multi-Leg Option Order Configuration

When the multi-leg (combination) option order page opens, queries the order configuration of the combination by the main security, the strategy type, and the security of each leg. The response has the same structure as Get Order Configuration (lot size, tick table, and order types, sessions, time in force, and authorization status in channel_infos) and also returns multi_leg: the combination code, name, strategy name, and the ratio quantity ratio_quantity of each leg. The Broker App should overwrite the local leg ratios with the returned ratio_quantity before estimating fees, estimating the available open quantity, and submitting the multi-leg order.

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

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 “Get Multi-Leg Option Order Configuration” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Order configuration of the combination. Fields not listed here have the same meaning as in Get Order Configuration

counter_idstring

Main security ID of the combination

namestring

Security name

lot_sizestring

Lot size

taginteger

Order tag. Pass it as each leg's order_tag when estimating multi-leg fees:

  • 1 - Regular order
  • 2 - Long-term order
  • 3 - Grey market order
Values
1
2
3
timestampstring

Current server time as a Unix timestamp in seconds

bid_sizesarray<object>

Tick table

Child attributes
bid_sizestring

Minimum price increment in this band, for example "0.01"

str_proceedstring

Lower bound of the band (exclusive)

end_proceedstring

Upper bound of the band (inclusive)

channel_infosobject

Trading configuration of the current account for this security. In addition to the fields below, the response contains several *_granted booleans (whether the corresponding authorization, certification, or risk statement is complete) with matching certification URL fields (*_url, *_granted_url). Some apply only to specific markets or businesses, and the server determines which fields are present. When a value is false, guide the user to the matching URL before submitting the order, and call this endpoint again afterward to refresh the status.

Child attributes
account_channelstring

Account channel. Together with org_id and aaid, it identifies the account this configuration belongs to.

org_idstring

Tenant ID

aaidstring

Asset account ID

currencystring

Quote currency of the security, for example USD, HKD, or GBX

settlement_currencyarray<string>

Available settlement currencies. The first item is the default trading currency; pass it as currency when you query positions and cash, buying power, and estimated fees.

order_type_configobject

Order type configuration available for this security and account. Keys are order type codes, for example LO (limit order), ELO (enhanced limit order), MO (market order), LIT (limit-if-touched), and MIT (market-if-touched). An order type that does not appear is unavailable. When this object is returned, use the per-order-type configuration for sessions and time in force.

support_tradeboolean

Whether the current account channel supports trading. When false, do not offer order entry.

restrictedinteger

Online trading restriction:

  • 1 - Online buying is not allowed
  • 2 - Online selling is not allowed
  • 3 - Neither online buying nor online selling is allowed

If the field is absent or has another value, no such restriction applies. For a restricted direction, direct the user to contact the Broker offline.

Values
1
2
3
support_rthboolean

Whether pre-market and after-hours trading is supported. When order_type_config is returned, support_sessions in it takes precedence.

support_overnightboolean

Whether overnight trading is supported. When order_type_config is returned, support_sessions in it takes precedence.

gtd_support_order_typesarray<string>

Order type codes that support good-till-date (GTD) orders

support_attached_order_typesarray<string>

Order type codes that accept attached orders

support_fractional_sharesboolean

Whether US fractional-share trading is supported

fractional_min_amountstring

Minimum amount, in USD, for a fractional-share order placed by amount. Orders below this amount are rejected.

mo_avail_ratiostring

Buying-power factor for market orders. Available buying power for a market order (including an untriggered market conditional order) equals buy_limit from Get Buying Power for Order Entry multiplied by this factor. Treat an empty value as 1.

finance_account_statusinteger

Margin credit status:

  • 0 - Normal
  • 1 - Credit limit is 0 and an adjustment request is under review
  • 2 - Credit limit is 0 and no request is under review

When the value is 1 or 2, trades that require margin credit, such as opening a short stock position or selling to open options, cannot proceed. Tell the user to wait for review or request a limit adjustment.

Values
0
1
2
account_risk_levelinteger

Account risk level:

  • 0 - No additional statement is required
  • 1 - The user must confirm the trade-anyway statement before ordering
  • 2 - The user must confirm the important notice before ordering
Values
0
1
2
confirm_purchase_statementboolean

Whether the user has confirmed the trade-anyway statement

confirm_important_noticeboolean

Whether the user has confirmed the important notice

granted_infoobject

Authorization status of each trading qualification and risk statement. Keys are qualification type codes, for example us_overnight_risk_agreement (US overnight trading risk statement) and fractional_shares_risk_agreement (fractional-share trading risk statement). The server determines the other keys.

multi_legobject

Display information of the multi-leg combination and the ratio of each leg

Child attributes
codestring

Combination code, used as the order title

namestring

Combination name

strategy_namestring

Strategy name

legsarray<object>

Ratio information of each leg

Child attributes
counter_idstring

Security ID of the leg

ratio_quantitystring

Ratio quantity of the leg per combination unit. Pass it as legs[].ratio_quantity when you submit the multi-leg order

Whale Docs