Skip to main content

List of Enumerations

Class

Class

Order

ParameterTypeMeaning
BuySellBsActionBuy/Sell Optional parameters: BsActionBuy Buy, BsActionSell Sell
SymbolstringStock Symbol
Price*stringOrder Price (If not using PriceTypeLimit (Limit Price), pass nil)
Quantityint64Order Quantity
MarketTypeMarketTypeMarket Type Optional parameters: MarketTypeCommon Regular, MarketTypeFixing Fixing, MarketTypeIntradayOdd Intraday Odd Lot, MarketTypeOdd Post-market Odd Lot, MarketTypeEmg Emerging, MarketTypeEmgOdd Emerging Odd Lot
PriceTypePriceTypePrice Flag Optional parameters: PriceTypeLimit Limit, PriceTypeLimitUp Limit Up, PriceTypeLimitDown Limit Down, PriceTypeMarket Market, PriceTypeReference Reference
TimeInForceTimeInForceOrder Condition Optional parameters: TimeInForceRod, TimeInForceFok, TimeInForceIoc
OrderTypeOrderTypeOrder Type Optional parameters: OrderTypeStock Common, OrderTypeMargin Margin, OrderTypeShort Short Sell, OrderTypeDayTrade Day Trade (for Day Trade Sell First), OrderTypeSbl SBL
UserDef*stringUser Defined Field (Max 10 characters, special characters and Chinese not supported. Not applicable for Emerging market)
caution

Different MarketType corresponds to different units and ranges for Quantity. Please refer to the Market Type description.

caution

When MarketType is one of MarketTypeCommon, MarketTypeOdd, or MarketTypeIntradayOdd, and PriceType is PriceTypeLimit, the Price field must be filled; otherwise, the Price field should be nil.

caution

For Day Trade Sell First operations: OrderType = OrderTypeDayTrade, BuySell must be BsActionSell, and MarketType must be MarketTypeCommon. (For other day trade entry/exit operations, orderType = OrderTypeStock)

OrderResult

Order List, retrieved via OrderResults(account).

ParameterTypeDescription
FunctionType*int64Function Type: 0 New Order, 10 Execute New Order, 15 Change Price, 20 Change Qty, 30 Cancel Order, 90 Fail
Date*stringTransaction Date
SeqNo*stringOrder Sequence Number
BranchNo*stringBranch Code
Account*stringAccount
OrderNo*stringOrder Number
AssetType*int64Asset Type: 0 Securities
Market*stringMarket Type: TAIEX Listed Stocks, TAISDAQ OTC Stocks, TAIEMG Emerging Stocks
MarketTypeMarketTypeMarket Type Category: MarketTypeCommon Regular, MarketTypeFixing Fixing, MarketTypeIntradayOdd Intraday Odd Lot, MarketTypeOdd Post-market Odd Lot, MarketTypeEmg Emerging, MarketTypeEmgOdd Emerging Odd Lot
StockNo*stringStock Symbol
BuySell*BsActionBuy/Sell Action: BsActionBuy Buy, BsActionSell Sell
PriceType*PriceTypeOriginal Order Price Type: PriceTypeLimit Limit, PriceTypeLimitUp Limit Up, PriceTypeLimitDown Limit Down, PriceTypeMarket Market, PriceTypeReference Reference
Price*stringPrice
Quantity*int64Original Order Quantity
TimeInForce*TimeInForceOrder Condition: TimeInForceRod ROD, TimeInForceFok FOK, TimeInForceIoc IOC
OrderType*OrderTypeOrder Type: OrderTypeStock Common, OrderTypeMargin Margin, OrderTypeShort Short Sell, OrderTypeDayTrade Day Trade, OrderTypeSbl SBL
IsPreOrder*boolIs Pre-order
Status*int64Order Status: 0 Pre-order, 4 Sending to Backend, 9 Connection Timeout, 10 Order Success, 30 Cancelled Unfilled, 40 Partial Fill/Rest Cancelled, 50 Fully Filled, 90 Fail
AfterPriceType*PriceTypeEffective Price Type: PriceTypeLimit Limit, PriceTypeLimitUp Limit Up, PriceTypeLimitDown Limit Down, PriceTypeMarket Market, PriceTypeReference Reference
AfterPrice*stringEffective Order Price
Unit*int64Unit
AfterQty*int64Effective Order Quantity (including filled part)
FilledQty*int64Filled Quantity
FilledMoney*int64Filled Amount
BeforeQty*int64Effective Qty Before Change
BeforePrice*stringEffective Price Before Change
UserDef*stringUser Defined Field
LastTime*stringLast Modified Time (Format: HH:MM:SS.fff or HH:MM:SS)
ErrorMessage*stringError Message
Details*[]OrderDetailOrder History (Value exists only when querying OrderResultsDetail or OrderHistory)
>> FunctionType*int64Function Type: 0 New Order, 10 Execute New Order, 15 Change Price, 20 Change Qty, 30 Cancel Order, 50 Fully Filled, 90 Fail
>> ModifiedTime*stringModified Time (Format: HH:MM:SS.fff or HH:MM:SS)
>> BeforeQty*int64Original Order Quantity
>> AfterQty*int64Effective Order Quantity (including filled part)
>> BeforePrice*stringOriginal Order Price
>> AfterPrice*stringEffective Order Price
>> FilledMoney*stringFilled Amount
>> Status*int64Order Status
>> ErrMsg*stringError Message
Time Format Description

last_time and modified_time format: HH:MM:SS.fff or HH:MM:SS (omitted when .fff = .000)

BatchResult

Batch Order List, retrieved via BatchOrderLists(account).

ParameterTypeMeaning
functionTypeintFunction Type: 0 New Order, 10 Execute New Order, 15 Change Price, 20 Change Qty, 30 Cancel Order, 90 Fail
datestringTransaction Date
branchNostringBranch Code
accountstringAccount
batchSeqNostringBatch Order Sequence Number

ModifyPriceObj

Modify Price Object

ParameterTypeMeaning
OrderResultOrderResultOrder List
Price*stringPrice after modification
PriceType*PriceTypePrice Type after modification: PriceTypeLimit Limit, PriceTypeLimitUp Limit Up, PriceTypeLimitDown Limit Down, PriceTypeMarket Market, PriceTypeReference Reference

ModifyQuantityObj

Modify Quantity Object

ParameterTypeMeaning
OrderResultOrderResultOrder List
Quantityint64Quantity after modification

FilledData

Filled Report Object

ParameterTypeMeaning
Date*stringDate
BranchNo*stringBranch Code
Account*stringAccount
SeqNo*stringOrder Sequence Number (Only returned for active reports)
OrderNo*stringOrder Number
StockNo*stringStock Symbol
BuySell*BsActionBuy/Sell Action: BsActionBuy Buy, BsActionSell Sell
OrderType*OrderTypeOrder Type: OrderTypeStock Common, OrderTypeMargin Margin, OrderTypeShort Short Sell, OrderTypeDayTrade Day Trade, OrderTypeSbl SBL
FilledNo*stringFill Sequence Number
FilledAvgPrice*stringFilled Average Price
FilledQty*int64Filled Quantity
FilledPrice*stringFilled Unit Price
FilledTime*stringFilled Time
UserDef*stringUser Defined Field (Only returned for active reports)

Account

Account Information

ParameterTypeMeaning
NamestringClient Name
AccountstringAccount
BranchNostringBranch Code
AccountTypestringAccount Type, returns stock for Securities, futopt for Futures/Options

Constants (Enum Values)

BsAction

Buy/Sell Action

NameValueMeaning
BsActionBuy1Buy
BsActionSell2Sell

MarketType

Market Type

NameValueMeaning
MarketTypeCommon1Regular (Common)
MarketTypeFixing2Fixing
MarketTypeOdd3Post-market Odd Lot
MarketTypeIntradayOdd4Intraday Odd Lot
MarketTypeEmg5Emerging
MarketTypeEmgOdd6Emerging Odd Lot

When using different MarketType, the unit and range represented by Quantity will differ, as shown below:

NameQuantity UnitQuantity Ranges
MarketTypeCommon1,000 Shares1000 ~ 499000
MarketTypeFixing1,000 Shares1000 ~ 499000
MarketTypeIntradayOddShares1 ~ 999
MarketTypeOddShares1 ~ 999
MarketTypeEmg1,000 Shares1000 ~ 499000
MarketTypeEmgOddShares1 ~ 999

When using different MarketType, the available PriceType and TimeInForce will differ, as shown below:

MarketTypeAvailable PriceTypeAvailable TimeInForce
MarketTypeCommonPriceTypeLimit, PriceTypeLimitUp, PriceTypeLimitDown, PriceTypeMarket, PriceTypeReferenceTimeInForceRod, TimeInForceIoc, TimeInForceFok
MarketTypeFixingPriceTypeReferenceTimeInForceRod
MarketTypeIntradayOddPriceTypeLimit, PriceTypeLimitUp, PriceTypeLimitDown, PriceTypeReferenceTimeInForceRod
MarketTypeOddPriceTypeLimit, PriceTypeLimitUp, PriceTypeLimitDown, PriceTypeReferenceTimeInForceRod
MarketTypeEmgPriceTypeLimitTimeInForceRod
MarketTypeEmgOddPriceTypeLimitTimeInForceRod

PriceType

Price Type

NameValueMeaning
PriceTypeLimit1Limit
PriceTypeLimitUp2Limit Up
PriceTypeLimitDown3Limit Down
PriceTypeMarket4Market
PriceTypeReference5Reference (Fixing Price during Fixing)

TimeInForce

Order Condition

NameValueMeaning
TimeInForceRod1Rest of Day (ROD)
TimeInForceFok2Fill-or-Kill (FOK)
TimeInForceIoc3Immediate-or-Cancel (IOC)

OrderType

Order Type

NameValueMeaning
OrderTypeStock1Common (Stock)
OrderTypeMargin2Margin
OrderTypeShort3Short Sell
OrderTypeSbl4SBL (Securities Borrowing and Lending)
OrderTypeDayTrade5Day Trade

StockType

Stock Category

NameValueMeaning
StockTypeStock0Stock
StockTypeConvertBond1Convertible Bond
StockTypeEtfAndEtn3ETF and ETN

FunctionType

Function Type

NameValue
New Order0
Execute New Order10
Change Price15
Change Qty20
Cancel Order30
Fully Filled (for Order History)50
Fail90

Market

Market

NameValue
Listed StocksTAIEX
OTC StocksTAISDAQ
Emerging StocksTAIEMG

Status

Order Status

NameValue
Pre-order0
Sending to Backend4 (Use OrderResults to check status)
Sending to Exchange8 (Use OrderResults to check status)
Connection Timeout9 (Please check OrderResults later or contact your agent)
Order Success10
Cancelled Unfilled30
Partial Fill/Rest Cancelled40
Fully Filled50
Order History Query Flag14 - Change Price ACK, 24 - Change Qty ACK, 34 - Cancel ACK
Change Price Success (Order History)15
Change Qty Success (Order History)20
Change Price Failed (Active Report)19
Change Qty Failed (Active Report)29
Cancel Failed (Active Report)39