Stock+ Orders
Stock+ Orders
Place Order
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read and write)
This interface is used to place stock/option orders.
Request Parameters
symbolSymbol, using ticker.region format, e.g. AAPL.US
orderTypeOrder type
LO Limit Order
MO Market Order
LIT Limit If Touched
MIT Market If Touched
TSLPAMT Trailing Stop Limit Order (Trailing Amount)
TSLPPCT Trailing Stop Limit Order (Trailing Percentage)
sideOrder side
Buy - Buy
Sell - Sell
submittedQuantityOrder quantity, e.g. 100
timeInForceOrder validity type
Day - Valid for the day
GoodTilCanceled - Valid until cancelled
GoodTilDate - Valid until expiry
submittedPriceOrder price, e.g. 388.5
Required for LO / LIT orders
triggerPriceTrigger price, e.g. 388.5
Required for LIT / MIT orders
limitOffsetSpecified spread, e.g. 1.2 means spread of 1.2 USD (for US stocks)
Required for TSLPAMT / TSLPPCT orders when limitDepthLevel is 0
trailingAmountTrailing amount
Required for TSLPAMT orders
trailingPercentTrailing percentage, in percentage points, e.g. 2.5 means 2.5%
Required for TSLPPCT orders
expireDateLong-term order expiry date, format:
YYYY-MM-DD, e.g. 2022-12-05
Required when timeInForce is GoodTilDate
outsideRthWhether to allow trading outside regular trading hours. Required for US stocks
RTHOnly - Do not allow pre/post market
AnyTime - Allow pre/post market
Overnight - Overnight trading
limitDepthLevelSpecified bid/ask level, range -5 to 5. Negative is bid level (e.g. -1 is best bid), positive is ask level (e.g. 1 is best ask). When 0, limitOffset takes effect
Valid for TSLPAMT / TSLPPCT orders
triggerCountTrigger count, range 0~3. The order is triggered after the condition is met this many times within 1 minute
Valid for LIT / MIT / TSLPAMT / TSLPPCT orders
monitorPriceMonitor price, the order starts monitoring only when the price reaches this level
Valid for TSLPAMT / TSLPPCT orders
remarkRemark (max 64 characters)
Place Order › Response Parameters
Successful response
codemsgrequestTimeorderIdSystem order ID
clientOidClient customized order ID. Returns empty string if not passed
symbolOption contract symbol
Modify Order
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read and write)
This interface is used to modify the price/quantity of unfilled or partially filled orders, with cancel & replace semantics.
Request Parameters
orderIdOrder ID
quantityModified quantity, e.g. 200
priceModified price, e.g. 388.5
Required for LO / LIT orders
triggerPriceTrigger price, e.g. 388.5
Required for LIT / MIT orders
limitOffsetSpecified spread
Required for TSLPAMT / TSLPPCT orders when limitDepthLevel is 0
trailingAmountTrailing amount
Required for TSLPAMT orders
trailingPercentTrailing percentage
Required for TSLPPCT orders
limitDepthLevelSpecified bid/ask level. Required for TSLPAMT / TSLPPCT orders
triggerCountTrigger count. Required for LIT / MIT / TSLPAMT / TSLPPCT orders
monitorPriceMonitor price. Required for TSLPAMT / TSLPPCT orders
remarkRemark (max 64 characters)
Modify Order › Response Parameters
Successful response
codemsgrequestTimeorderIdSystem order ID after modification
clientOidClient customized order ID. Returns empty string if not passed
symbolOption contract symbol
Cancel Order
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read and write)
This interface is used to cancel unfilled or partially filled orders.
Request Parameters
symbolOption contract symbol
orderIdSystem order ID. At least one of orderId and clientOid must be passed; orderId takes priority when both are passed
clientOidClient customized order ID. At least one of orderId and clientOid must be passed
Cancel Order › Response Parameters
Successful response
codemsgrequestTimeorderIdSystem order ID
clientOidClient customized order ID. Returns empty string if not passed
symbolOption contract symbol
Check Today Orders
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read only)
This interface is used to query today's orders and order details.
Request Parameters
symbolSymbol, using ticker.region format, e.g. AAPL.US
statusOrder status, e.g. status=Filled&status=New
NotReported - Not reported
ReplacedNotReported - Replaced not reported
ProtectedNotReported - Protected not reported
VarietiesNotReported - Varieties not reported
Filled - Fully filled
WaitToNew - Waiting for new
New - New
WaitToReplace - Waiting for replace
PendingReplace - Pending replace
Replaced - Replaced
PartialFilled - Partially filled
WaitToCancel - Waiting for cancel
PendingCancel - Pending cancel
Rejected - Rejected
Canceled - Canceled
Expired - Expired
PartialWithdrawal - Partial withdrawal
sideOrder side
Buy - Buy
Sell - Sell
marketMarket
US - US stocks
orderIdOrder ID for specific order query, e.g. 701276261045858304
Check Today Orders › Response Parameters
Successful response
codemsgrequestTimeOrder information
Check History Orders
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read only)
This interface is used to query historical orders.
Request Parameters
symbolSymbol, using ticker.region format, e.g. AAPL.US
statusOrder status, e.g. status=Filled&status=New
NotReported - Not reported
ReplacedNotReported - Replaced not reported
ProtectedNotReported - Protected not reported
VarietiesNotReported - Varieties not reported
Filled - Fully filled
WaitToNew - Waiting for new
New - New
WaitToReplace - Waiting for replace
PendingReplace - Pending replace
Replaced - Replaced
PartialFilled - Partially filled
WaitToCancel - Waiting for cancel
PendingCancel - Pending cancel
Rejected - Rejected
Canceled - Canceled
Expired - Expired
PartialWithdrawal - Partial withdrawal
sideOrder side. Buy - Buy, Sell - Sell
marketMarket. US - US stocks
startAtStart time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days before end time or current time
endAtEnd time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days after start time or current time
Check History Orders › Response Parameters
Successful response
codemsgrequestTimehasMoreWhether there is more data. Max 1000 orders per query; hasMore is true when results exceed 1000
Order information
Check Order Detail
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read only)
This interface is used to query order detail information.
Request Parameters
orderIdOrder ID, e.g. 701276261045858304
Check Order Detail › Response Parameters
Successful response
codemsgrequestTimeorderIdOrder ID
statusOrder status
NotReported - Not reported
ReplacedNotReported - Replaced not reported
ProtectedNotReported - Protected not reported
VarietiesNotReported - Varieties not reported
Filled - Fully filled
WaitToNew - Waiting for new
New - New
WaitToReplace - Waiting for replace
PendingReplace - Pending replace
Replaced - Replaced
PartialFilled - Partially filled
WaitToCancel - Waiting for cancel
PendingCancel - Pending cancel
Rejected - Rejected
Canceled - Canceled
Expired - Expired
PartialWithdrawal - Partial withdrawal
stockNameStock name
quantityOrder quantity
executedQuantityExecuted quantity. "0" for unfilled orders
priceOrder price. null when market conditional order not yet triggered
executedPriceExecuted price. "0" for unfilled orders
submittedAtOrder submission time
sideOrder side. Buy - Buy, Sell - Sell
symbolSymbol, using ticker.region format, e.g. AAPL.US
orderTypeOrder type
LO Limit Order
MO Market Order
LIT Limit If Touched
MIT Market If Touched
TSLPAMT Trailing Stop Limit Order (Trailing Amount)
TSLPPCT Trailing Stop Limit Order (Trailing Percentage)
lastDoneLatest traded price. "0" for unfilled orders
triggerPriceTrigger price for LIT/MIT orders. null for non-conditional orders
msgRejection reason or remark. Empty string by default
tagOrder tag
Normal - Normal order
GTC - GTC order
timeInForceOrder validity type
Day - Valid for the day
GoodTilCanceled - Valid until cancelled
GoodTilDate - Valid until expiry
expireDateLong-term order expiry date, format:
YYYY-MM-DD. null for non-GTD orders
updatedAtLast update time (ISO 8601). null if never updated
triggerAtConditional order trigger time, timestamp (ISO 8601)
trailingAmountTSLPAMT order trailing amount. null for non-TSLPAMT orders
trailingPercentTSLPPCT order trailing percentage. null for non-TSLPPCT orders
limitOffsetTSLPAMT/TSLPPCT order spread. null for non-TSLP orders
triggerStatusConditional order trigger status. null for non-conditional orders
NOT_USED - Not active
DEACTIVE - Deactivated
ACTIVE - Active
RELEASED - Triggered
currencySettlement currency
outsideRthAllow pre/post market trading. UnknownOutsideRth for non-US orders
RTHOnly - Do not allow
AnyTime - Allow
Overnight - Overnight
remarkRemark
limitDepthLevelSpecified bid/ask level
triggerCountTrigger count
monitorPriceMonitor price
freeStatusCommission-free status. Default None
None - None
Calculated - To be calculated
Pending - Pending
Ready - Completed
freeAmountCommission-free amount. Default null
freeCurrencyCommission-free currency. Default null
deductionsStatusDeduction/rebate status. Default None
None - Pending settlement / No data
Pending - Settled, pending issuance
Done - Settled, issued
deductionsAmountDeduction amount. Default null
deductionsCurrencyDeduction currency. Default null
platformDeductedStatusPlatform fee deduction/rebate status. Default None
None - Pending settlement / No data
Pending - Settled, pending issuance
Done - Settled, issued
platformDeductedAmountPlatform fee deduction amount. Default null
platformDeductedCurrencyPlatform fee deduction currency. Default null
Order history details
Order charges
Check Today Executions
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read only)
This interface is used to query today's order execution details.
Request Parameters
symbolSymbol, using ticker.region format, e.g. AAPL.US
orderIdOrder ID, e.g. 701276261045858304
Check Today Executions › Response Parameters
Successful response
codemsgrequestTimeExecution detail information
Check History Executions
Rate limit: 30 times/30s (UID), minimum interval 0.02 seconds
Permission: Trade (read only)
This interface is used to query historical order execution records, including buy and sell execution records. Does not support today's execution query.
Request Parameters
symbolSymbol, using ticker.region format, e.g. AAPL.US
startAtStart time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days before end time or current time
endAtEnd time, timestamp in seconds, e.g. 1650410999. Defaults to 90 days after start time or current time
Check History Executions › Response Parameters
Successful response
codemsgrequestTimehasMoreWhether there is more data. Max 1000 orders per query; hasMore is true when results exceed 1000
Execution detail information
