Skip to content
Order Submission

Submit Stock Order

Submits a non-option order for stocks, ETFs, warrants, and similar securities. It covers limit, market, enhanced limit, auction, odd-lot, order-by-amount (US fractional shares), conditional orders (SLO, LIT, MIT), trailing stop, market on close, attached orders (take-profit, stop-loss, bracket), and pre-market, after-hours, and overnight sessions. Before submission, the Client should have confirmed the order on the order page and unlocked trading. The order type, session, time in force, and attached order must be within the ranges returned by Get Order Configuration, and the required authorizations and declarations must be completed. This endpoint is also used by the day-trade margin order panel and by order cards in AI conversations.

A successful response means the order has been accepted, not filled. Use the order details or order push to track its status. After success, if notice is not empty, show the trading reminder to the Client, then refresh the order list and assets. On failure, show message to the Client so the Client can modify the order and resubmit.

When you call this endpoint through WhaleCore requestService(), set requiresTradeToken to true.

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

POSThttps://api.lbkrs.com/v3/orders/submit

Request body application/json

counter_idstringrequired

Security ID (counter_id), such as ST/US/AAPL or ST/HK/700

actionstringrequired

Order side:

  • 1 - Buy
  • 2 - Sell
Values
1
2
order_typestringrequired

Order type code. It must be a key of channel_infos.order_type_config in Get Order Configuration:

  • LO - Limit order
  • MO - Market order
  • ELO - Enhanced limit order
  • ALO - At-auction limit order
  • AO - At-auction order
  • ODD - Odd-lot order
  • SLO - Special limit order
  • LIT - Limit if touched
  • MIT - Market if touched
  • TSL - Trailing stop limit
  • TS - Trailing stop market
  • MOC - Market on close

For a trailing stop, set the trailing distance with tailing_percent (by percentage) or tailing_amount (by amount). A trailing stop limit order also takes limit_offset, the price offset of the order placed after the trigger. TSLPPCT and TSLPAMT are also accepted and appear as TSL on the order.

The configuration key GT means the security supports grid trading, which is not placed through this endpoint. Hong Kong stocks do not support LO; use ELO for Hong Kong limit orders.

pricestring

Limit price in the trading currency. Omit it for market-type orders and trailing stop orders

quantitystringrequired

Order quantity: shares for stocks, contracts for options, or combinations for multi-leg orders. It must match the lot size returned by Get Order Configuration

submitted_amountstring

Order amount when ordering by amount, used for US fractional shares. It must not be lower than channel_infos.fractional_min_amount returned by Get Order Configuration

settlement_currencystringrequired

Settlement currency, such as USD or HKD. Use an item of channel_infos.settlement_currency returned by Get Order Configuration

time_in_forceinteger

Time in force. The value must be in support_time_in_forces of the order type in Get Order Configuration:

  • 0 - Day (DAY)
  • 1 - Good till canceled (GTC)
  • 3 - Immediate or cancel (IOC)
  • 5 - Fill or kill (FOK)
  • 6 - Good till date (GTD); expire_time is also required

If omitted, the order is treated as a day order.

Values
0
1
3
5
6
expire_timestring

Order expiry time as a Unix timestamp in seconds. Required when time_in_force is 6

force_only_rthstring

Trading session. Use an item of support_sessions of the order type in Get Order Configuration:

  • 1 - Regular trading hours only
  • 2 - Regular trading hours plus pre-market and after-hours
  • 3 - Overnight session only
  • 4 - Pre-market (option overnight scenario)

Omit it when the security does not support session selection.

trigger_pricestring

Trigger price. Required for conditional orders such as SLO, LIT, and MIT

market_pricestring

Latest market price when the conditional order is submitted. Compare it with trigger_price to determine trend

trendstring

Trigger direction of a conditional order:

  • 1 - Triggered when the price rises to the trigger price (the trigger price is above market_price)
  • 2 - Triggered when the price falls to the trigger price
Values
1
2
trigger_countstring

Trigger count of the conditional order

tailing_amountstring

Trailing amount of a trailing stop order (pass it when trailing by amount)

tailing_percentstring

Trailing percentage of a trailing stop order (pass it when trailing by percentage)

limit_offsetstring

Limit offset of a trailing stop limit order: after triggering, the order is placed at the market price plus or minus this offset. Omit it when limit_depth_level is passed

limit_depth_levelinteger

Order book level (such as best bid or best ask) used to price a trailing stop limit order. When it is 0 or omitted, limit_offset is used

monitor_pricestring

Monitoring price of a trailing stop order

card_idsarray<string>

IDs of the cards used by this order, at most one per category (commission-free card, cash card, platform fee deduction card). Cash cards cannot be used for sell orders. If the array is empty or omitted, no card is redeemed for this order

commission_freeboolean

Whether a commission-free card may be used to offset commission

amount_deductedboolean

Whether a stock cash card may be used for deduction

platform_amount_deductedboolean

Whether a platform fee deduction card may be used

client_request_idstring

Client request identifier: the millisecond timestamp at submission

attached_paramsobject

Attached order (take-profit / stop-loss) parameters. An attached order belongs to the main order submitted in this request and is activated only after the main order is filled. Only order types listed in channel_infos.support_attached_order_types returned by Get Order Configuration support attached orders

Child attributes
attached_order_typeintegerrequired

Attached order type:

  • 1 - Take-profit order
  • 2 - Stop-loss order
  • 3 - Bracket order (both take-profit and stop-loss)
Values
1
2
3
profit_taker_pricestring

Take-profit trigger price. Required when attached_order_type is 1 or 3

stop_loss_pricestring

Stop-loss trigger price. Required when attached_order_type is 2 or 3

activate_order_typestring

Order type after the attached order is activated, such as LIT (limit if touched) or MIT (market if touched)

profit_taker_submit_pricestring

Limit price of the take-profit order after activation. Pass it when activate_order_type is LIT

stop_loss_submit_pricestring

Limit price of the stop-loss order after activation. Pass it when activate_order_type is LIT

activate_rthstring

Trading session after activation:

  • 1 - Regular trading hours only
  • 2 - Regular trading hours plus pre-market and after-hours
Values
1
2
time_in_forceinteger

Time in force of the attached order:

  • 0 - Day (DAY)
  • 1 - Good till canceled (GTC)
  • 3 - Immediate or cancel (IOC)
  • 5 - Fill or kill (FOK)
  • 6 - Good till date (GTD); expire_time is also required
Values
0
1
3
5
6
expire_timestring

Expiry time of the attached order as a Unix timestamp in seconds. Required when time_in_force is 6

Responses

HTTP 200The request succeeded. The response body contains the result of the “Submit Stock Order” operation.
Standard response envelopecodemessagedata
dataobjectdata structure

Order submission result

idstring

ID of the new order, which you can use to query the order details

noticestring

Trading reminder text. When it is not empty, the Broker App should show it to the Client after the order is submitted

Whale Docs