Place Order

Place Common Order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
string
required

Stock/futures symbol,examples:AAPL, 00700, SG9999005961.SGD

string
enum
required

Order type. MKT=Market, LMT=Limit, STP=Stop, STP_LMT=Stop-Limit, TRAIL=Trailing Stop, VWAP=VWAP, TWAP=TWAP, AM=HK Opening/Closing Auction, AL=HK Auction Limit, ICEBERG=Iceberg order.

string
enum
required

Order side.

Allowed:
string
enum
required

Security type. STK=Stock, OPT=Option, WAR=Warrant, IOPT=Inline warrant/CBBC, CASH=Forex spot, FUT=Futures, FOP=Futures option, FUND=Fund, FOREX=Forex derivative, MLEG=Multi-leg, CC=Crypto/Digital assets.

integer

number of shares of stock or lots of futures/options

integer

scale of quantity. if real quantity is 0.1, can set quantity=1 and quantityScale=10

string

options, warrants, strike price,example: 100.0

string

options, warrants,expiration time, format: yyyyMMdd

string
enum

options, warrants right.

Allowed:
string
enum

Time in force,can be "DAY", "GTC"(good til cancel), "GTD"(good til date), Default value:DAY, FUND Order will always set to GTC.

Allowed:
number

Limit price, required when orderType is LMT, STP_LMT, optional when VWAP, TWAP (if the limit price is filled in, the order will be filled according to the limit price)

number

Fund Order Required. The Amount of the order.

number

Order Stop Price Required when orderType is STP/STP_LMT

number

Fund Order Required. The order commission.

boolean

Whether to allow pre and after hours trading, false allows only intraday trading, true allows pre and after hours trading, default value is true. Hong Kong stocks set to true means pre-market bidding.

string
number

upfront fee proportion. if 1%, pass 0.01

boolean

is internal fee, default False

string

user remark info

string
enum

Attached order type. Only supported for STK/OPT/FUT; main order must be LMT, MKT, STP_LMT, or STP.

Allowed:
string

required when 'attachType' is 'PROFIT' or 'BRACKETS'

number

take profit order's limit price, required when 'attachType' is 'PROFIT' or 'BRACKETS'

string
enum

Time in force,Default value:DAY

Allowed:
boolean

take profit order's 'outsideRth', Default value:true

string
enum

Stop loss order type, required when attachType is LOSS or BRACKETS.

Allowed:
string

required when 'attachType' is 'LOSS' or 'BRACKETS'

number

stop loss order's trigger price, required when 'attachType' is 'LOSS' or 'BRACKETS'

number

stop loss order's limit price'

string
enum

Time in force,Default value:DAY

Allowed:
boolean

stop loss order's 'outsideRth', Default value:true

string
enum

Trail type of TRAIL order.

Allowed:
number

Trailing stop condition value, when trailType is PERCENT.
for example, set 25.15%, then trailAmount should be 25.15

number

Expire time of GTD order

string
enum

Option combo type

contracts
array of objects

Contracts list, only required when comboType was set. example: [
{
"symbol": "TSLA",
"secType": "OPT",
"expiry": "20240621",
"strike": 170,
"right": "CALL",
"action": "BUY",
"ratio": 1
},
{
"symbol": "TSLA",
"secType": "OPT",
"expiry": "20240621",
"strike": 175,
"right": "CALL",
"action": "SELL",
"ratio": 1
}
]

contracts
int64

(TWAP and VWAP specific) Effective start time (13-digit timestamp). like: 1726135200000

int64

(TWAP and VWAP specific) Effective end time (13-digit timestamp)

double
0.01 to 0.5

(VWAP-specific) participation rate. valid value: 0.01 ~ 0.5

integer

(ICEBERG-specific) The displayed quantity for an iceberg order. Must be less than totalQuantity. The order book will only show this many shares at a time.

integer

(ICEBERG-specific) Minimum display size for an iceberg order. When the remaining quantity falls below displaySize, this value is used instead.

integer

(ICEBERG-specific) Time interval in seconds between each price check/refresh cycle for the iceberg order.

string
enum

Trading session type. Controls whether the order participates in extended-hours sessions. PRE_RTH_POST: pre-market + regular + post-market; RTH: regular trading hours only; OVERNIGHT: overnight session; FULL: all sessions; HK_AUC: HK auction session; HK_CTS: HK continuous trading; HK_AUC_CTS: HK auction + continuous.

Allowed:
Headers
string
required

The token obtained from the /oauth2/v1/token endpoint

string
required

The Tiger user who initiated the request, usually is the advisor

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json