Place Allocation Order

post

https://openapi.tigerfintech.com/api/v1/orders/allocations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

accountId

string

required

idempotencyKey

string

required

symbol

string

required

Stock/futures symbol，format：AAPL

expiry

string

options, warrants,expiration time, format: yyyyMMdd

strike

string

options, warrants, strike price,example: 100.0

right

string

enum

options, warrants, right,Format：PUT/CALL

Allowed:

quantity

integer

number of shares of stock or lots of futures/options

timeInForce

string

enum

time in force，Format:GTC/DAY/GTD, Default:DAY

Allowed:

price

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)

cashAmount

number

Fund Order Required. The Amount of the order.

stopLossPrice

number

Order Stop Price Required when orderType is STP/STP_LMT

orderType

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.

action

string

enum

required

Order side.

Allowed:

secType

string

enum

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.

commission

number

Fund Order Required. The order commission.

outsideRth

boolean

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

source

string

rejectStrategy

integer

required

Sub-order rejection policy. 0 = ONE_REJECT_ALL (default): if any sub-order is rejected, all others are also rejected; 1 = ONE_REJECT_ONE: a rejected sub-order does not affect the other sub-orders.

allocations

array of objects

required

allocations*

expireTime

number

Expire time of GTD order

displaySize

integer

(ICEBERG-specific) The displayed quantity for an iceberg order. Must be less than totalQuantity.

minDisplaySize

integer

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

checkIntervals

integer

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

tradingSessionType

string

enum

Trading session type. PRE_RTH_POST=Pre/During/After regular hours, RTH=Regular hours only, OVERNIGHT=Overnight session, FULL=Full session, HK_AUC=HK Auction, HK_CTS=HK Continuous Trading, HK_AUC_CTS=HK Auction + Continuous.

Allowed:

Headers

Authorization

string

required

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

X-TIGR-UID

string

required

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

content-type

string

enum

Defaults to application/json

Generated from available request content types

Response

200OK