Skip to main content

List of Enumerations

Class​

Class

OrderObject​

ParameterTypeMeaning
buy_sellBSActionBuy/Sell Type valid in Buy, Sell
symbolstringSymbol
buy_sell2 (optional)BSActionSpread Order Buy/Sell Type
symbol2 (optional)stringSpread Order Symbol
pricestringOrder Price
lotintOrder Lot
market_typeFutOptMarketTypeTrading Session valid in Future, Option, FutureNight, OptionNight
price_typeFutOptPriceTypePrice Type valid in Limit, Market, RangeMarket, Reference
time_in_forceTimeInForceTime In Force valid in ROD, FOK, IOC
order_typeFutOptOrderTypeOrder Type valid in New, Close, Auto, FdayTrade
user_def (optional)stringCustomer Field (Up to 10 characters, no special characters supported)
caution

If FutOptPriceType.Limit, the 'price' field must be filled; otherwise, the 'price' field should be empty or None

FutOptOrderResult​

OrderResult, You can using get_order_result(accounts) get data.

ParameterTypeMeaning
function_typeintFunction Type : 0 New, 10 Execute New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 90 Failed
datestringTransaction Date
seq_nostringOrder Serial Number
branch_nostringBranch Number
accountstringAccount
order_nostringOrder Number
asset_typeintAsset Type : 1 Future, 2 Option
marketstringMarket Type : TAIMEX Future, Option
market_typeFutOptMarketTypeTrading Session Type : Future, Option, FutureNight After-Hour Future, OptionNight After-Hour Option
unitintUnit
currencystringTrading Currency
symbolstringSymbol
expiry_datestringExpiry Date
strike_pricefloatStrike Price
call_putstringCall / Put : Call, Put
buy_sellBSActionBuy/Sell Type : Buy, Sell
symbol_leg2stringSpread Symbol
expiry_date_leg2stringExpiry Date - Spread Order
strike_price_leg2floatStrike Price - Spread Order
call_put_leg2stringCall / Put - Spread Order: Call, Put
buy_sell_leg2BSActionBuy/Sell Type - Spread Order: Buy, Sell
price_typeFutOptPriceTypeOriginal Order Price Type : Limit, Market, RangeMarket Market with Protection Orders, Reference
pricefloatOrder Price
lotsintOriginal Order Lot
time_in_forceTimeInForceTime In Force : ROD FOK, IOC
order_typeFutOptOrderTypeOrder Type : New, Close, Auto, FdayTrade DayTrade
is_pre_orderboolReservation Order Flag
statusintOrder Status : 0 Reservation, 4 InQueue, 9 TimeOut, 10 New Order, 30 Cancel Order, 50 Fully Filled, 90 Order Failed
after_price_typeFutOptPriceTypeValid Order Price Type : Limit Market, RangeMarket Market with Protection Orders, Reference
after_pricefloatValid Order Price
unitintTrading Unit
after_lotintValid Order Lot
filled_lotintFilled Lot
filled_moneyfloatFilled Value
before_lotintBefore the Lot Modification
before_pricefloatBefore the Price Modification
user_defstringCustom Fields
last_timestringLast Modification Time
error_messagestringError Message
detailslistOrder Process (Return value when query order_result_detail or order_history )
>> function_typeintFunction Type : 10 Execute New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 50 Fully Filled, 90Failed
>> modified_timestringOrder Modified Time
>> before_lotintOriginal Order Lot
>> after_lotintValid Order Lot
>> before_pricefloatOriginal Order Price
>> after_pricefloatValid Order Price
>> filled_moneyfloatFilled Value
>> error_messagestringError Message

BatchResult​

BatchResult, You can using BatchOrderLists(accounts) get data.

ParameterTypeMeaning
function_typeintFunction Type : 0 New, 15 Amend Price, 20 Amend Lot, 30 Cancel
datestringDate
branch_nostringBranch Number
accountstringAccount
batch_seq_nostringBatch Serial Number

FutOptModifyPrice​

Modified Price Object

ParameterTypeMeaning
FutOptOrderResultObjectFutOptOrderResult
pricestringThe price after modification
Price_typeFutOptPriceTypeThe price type after modification : Limit Market, RangeMarket Market with Protection Orders, Reference

FutOptModifyLot​

Modified Lot Object

ParameterTypeMeaning
FutOptOrderResultObjectFutOptOrderResult
lotintThe lot after modification

FutOptFilledData​

Filled Data Object

ParameterTypeMeaning
datestringFilled Date
branch_nostringBranch Number
accountstringAccount
seq_nostringOrder Serial Number (only display on filled callback)
order_nostringOrder Number
symbolstringSymbol
expiry_datestringExpiry Date
strike_pricefloatStrike Price
call_putCallPutCall / Put : Call, Put
buy_sellBSActionBuy/Sell Type : Buy, Sell
symbol_leg2stringSpread Symbol
expiry_date_leg2stringExpiry Date - Spread Order
strik_price_leg2floatStrike Price - Spread Order
call_put_leg2CallPutCall / Put : Call, Put
buy_sell_leg2BSActionBuy/Sell Type - Spread Order: Buy, Sell
filled_nostringFilled Serial Number
filled_avg_pricefloatFilled Average Price
filled_qtyintFilled Share
filled_pricefloatFilled Price
filled_timestringFilled Time
user_defstringCustom Fields (only display on filled callback)

Account​

Account Information

ParameterTypeMeaning
namestringCustomer Name
accountstringAccount
branch_nostringBranch Number
account_typestringAccount Type : stock, futopt

Constants ( Corresponding Values for Returned Fields )​

BSAction​

Buy / Sell Type

NameMeaning
BuyBuy
SellSell

CallPut​

Call / Put Type

NameMeaning
CallCall
PutPut

FutOptMarketType​

Trading Session Type

NameMeaning
FutureFuture Commodity
OptionOption Commodity
FutureNightAfter-Hour Future
OptionNightAfter-Hour Option

FutOptPriceType​

Price Type

NameMeaning
LimitLimit
MarketMarket
RangeMarketMarket with Protection Orders
ReferenceReference Price

TimeInForce​

Time In Force

NameMeaning
RODRest of Day
FOKFill-or-Kill
IOCImmediate-or-Cancel

FutOptOrderType​

Order Type

NameMeaning
NewOpen Position
CloseClose Position
AutoAuto
FdayTradeDayTrade

function_type​

Function Type

NameValue
New Order0
Execute New Order10
Amend Price15
Amend Lot20
Cancel Order30

market​

Market Category

NameValue
Future / OptionTAIMEX

status​

Order Status

NameValue
Reservation0
Received by the middle office4 (use get_order_results to retrieve the latest status)
Processing reported by the exchange8 (often observed for orders not priced at the limit-up or limit-down price; not shown by get_result or get_result_detail)
Back-office connection timeout9 (query again later with get_order_results, or contact your broker)
Order or modification succeeded10 (successful price or quantity modifications also return 10; inspect the returned fields to identify the modification)
Cancellation successful30
Partially filled; remainder cancelled40
Fully filled50
Price modification failed19
Quantity modification failed29
Cancellation failed39
Failed90

Futures orders do not use the price/quantity modification success statuses 15 and 20 or the ACK statuses 14, 24, and 34. See Error and Status Code Reference.

Month​

Month Code

Future​

JanFebMarAprMayJun
ABCDEF
JulAugSepOctNovDec
GHIJKL

Option​

Call

JanFebMarAprMayJun
ABCDEF
JulAugSepOctNovDec
GHIJKL

Put

JanFebMarAprMayJun
MNOPQR
JulAugSepOctNovDec
STUVWX