Check Order

post

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

Check whether the capital/position is sufficient. Returns information on estimated commissions, margin usage, etc.

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

quantityScale

integer

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

timeInForce

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:

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)

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

BUY/SELL

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.

outsideRth

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.

source

string

showCharges

boolean

Whether to return the cost breakdown. Only valid for /order/check api

upfrontProportion

number

upfront fee proportion. if 1%, pass 0.01

isInternalFee

boolean

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

Response

200OK