Skip to main content

List of Enumerations

Class

Class

OrderObject

ParameterTypeMeaning
buySellBSActionBuy/Sell Type valid in Buy, Sell
symbolstringSymbol
buySell2BSActionBuy/Sell Type - spread order
symbol2stringSymbol - spread order
pricestringOrder Price
lotintOrder Lot
marketTypeFutOptMarketTypeTrading Session valid in Future, Option, FutureNight, OptionNight
priceTypeFutOptPriceTypePrice Type valid in Limit, Market, RangeMarket Market with Protection Orders, Reference
timeInForcetimeInForceTime In Force valid in ROD, FOK, IOC
orderTypeFutOptOrderTypeOrder Type valid in New, Close, Auto, FdayTrade
userDef (optional)stringCustomer Field (Up to 10 characters, no special characters supported)

FutOptOrderResult

OrderResult can be obtained using GetOrderResult(accounts).

ParameterTypeMeaning
functionTypenumberFunction Type: 0 New, 10 Execute New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 90 Failed
datestringTransaction Date
seqNostringOrder Serial Number
branchNostringBranch Number
accountstringAccount
orderNostringOrder Number
assetTypenumberAsset Type: 1 Future, 2 Option
marketstringMarket Type: TAIMEX Future or Option
marketTypeFutOptMarketTypeTrading Session Type: Future, Option, FutureNight, OptionNight
unitnumberUnit
currencystringCurrency
symbolstringSymbol
expiryDatestringExpiry Date
strikePricenumberStrike Price
callPutstringCall / Put: Call, Put
buySellBSActionBuy/Sell Type: Buy, Sell
symbolLeg2stringSymbol - second leg of spread order
expiryDateLeg2stringExpiry Date - second leg of spread order
strikePriceLeg2numberStrike Price - second leg of spread order
callPutLeg2stringCall / Put - second leg of spread order: Call, Put
buySellLeg2BSActionBuy/Sell Type - second leg of spread order: Buy, Sell
priceTypeFutOptPriceTypeOriginal Order Price Type: Limit, Market, RangeMarket, Reference
pricenumberOrder Price
lotnumberOriginal Order Lot
timeInForceTimeInforceTime In Force: ROD, FOK, IOC
orderTypeFutOptOrderTypeOrder Type: New, Close, Auto, FdayTrade
isPreOrderboolReservation Order Flag
statusnumberOrder Status: 0 Reservation, 4 InQueue, 9 TimeOut, 10 New Order, 30 Cancel Order, 50 Fully Filled, 90 Order Failed
afterPriceTypeFutOptPriceTypeEffective Order Price Type: Limit, Market, RangeMarket, Reference
afterPricenumberEffective Order Price
afterLotnumberEffective Order Lot
filledLotnumberFilled Lot
filledMoneynumberFilled Value
beforeLotnumberEffective Lot Before Modification
beforePricenumberEffective Price Before Modification
userDefstringCustom Field
lastTimestringLast Modification Time
errorMessagestringError Message
detaillistOrder Process (returned by orderResultDetail or orderHistory)
>> functionTypenumberFunction Type: 10 New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 50 Filled, 90 Failed
>> modifiedTimestringModified Time
>> beforeLotnumberOriginal Order Lot
>> afterLotnumberEffective Order Lot
>> beforePricenumberOriginal Order Price
>> filledMoneynumberFilled Value
>> afterPricenumberEffective Order Price
>> errorMessagestringError Message

BatchResult

BatchResult can be obtained using BatchOrderLists(accounts).

ParameterTypeMeaning
functionTypenumberFunction Type : 0 New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 90 Failed
datestringDate
branchNostringBranch Aumber
accountstringAccount
batchSeqNostringBatch Serial Number

FutOptModifyPrice

Modified Price Object

ParameterTypeMeaning
FutOptOrderResultObjectFutOptOrderResult
pricenumberThe price after modification
PriceTypeFutOptPriceTypeThe price type after modification : Limit, Market, RangeMarket Market with Protection Orders, Reference

FutOptModifyLot

Modified Lot Object

ParameterTypeMeaning
FutOptOrderResultObjectFutOptOrderResult
lotnumberThe lot after modification

FutOptFilledData

Filled Data Object

ParameterTypeMeaning
datestringFilled Date
branchNostringBranch Number
accountstringAccount
seqNostringOrder serial number (only display on filled callback)
orderNostringOrder Number
symbolstringSymbol
expiryDatestringExpiry Date
strikePricenumberStrike Price
callPutCallPutCall / Put : Call, Put
buySellBSActionBuy/Sell Type : Buy, Sell
symbolLeg2stringSpread Symbol
expiryDateLeg2stringExpiry Date - Spread Order
strikePriceLeg2numberStrike Price - Spread Order
callPutLeg2CallPutCall / Put : Call, Put
buySellLeg2BSActionBuy/Sell Type - Spread Order: Buy, Sell
filledNostringFilled Serial Number
filledAvgPricenumberFilled Average Price
filledLotnumberFilled Share
filledPricenumberFilled Price
filledTimestringFilled Time
userDefstringCustom Fields (only display on filled callback)

Account

Account Information

ParameterTypeMeaning
namestringCustomer Name
accountstringAccount
branchNostringBranch Number
accountTypestringAccount 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 Regular Session
OptionOption Regular Session
FutureNightFuture After-Hours
OptionNightOption After-Hours

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
NewCommon Stock
CloseMargin
AutoShort sale
FdayTradeDayTrade

functionType

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 getOrderResults 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 getOrderResults, 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