List of Enumerations
Class
Class
OrderObject
| Parameter | Type | Meaning |
|---|---|---|
| buySell | BSAction | Buy/Sell Type valid in Buy, Sell |
| symbol | string | Symbol |
| buySell2 | BSAction | Buy/Sell Type - spread order |
| symbol2 | string | Symbol - spread order |
| price | string | Order Price |
| lot | int | Order Lot |
| marketType | FutOptMarketType | Trading Session valid in Future, Option, FutureNight, OptionNight |
| priceType | FutOptPriceType | Price Type valid in Limit, Market, RangeMarket Market with Protection Orders, Reference |
| timeInForce | timeInForce | Time In Force valid in ROD, FOK, IOC |
| orderType | FutOptOrderType | Order Type valid in New, Close, Auto, FdayTrade |
| userDef (optional) | string | Customer Field (Up to 10 characters, no special characters supported) |
FutOptOrderResult
OrderResult can be obtained using GetOrderResult(accounts).
| Parameter | Type | Meaning |
|---|---|---|
| functionType | number | Function Type: 0 New, 10 Execute New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 90 Failed |
| date | string | Transaction Date |
| seqNo | string | Order Serial Number |
| branchNo | string | Branch Number |
| account | string | Account |
| orderNo | string | Order Number |
| assetType | number | Asset Type: 1 Future, 2 Option |
| market | string | Market Type: TAIMEX Future or Option |
| marketType | FutOptMarketType | Trading Session Type: Future, Option, FutureNight, OptionNight |
| unit | number | Unit |
| currency | string | Currency |
| symbol | string | Symbol |
| expiryDate | string | Expiry Date |
| strikePrice | number | Strike Price |
| callPut | string | Call / Put: Call, Put |
| buySell | BSAction | Buy/Sell Type: Buy, Sell |
| symbolLeg2 | string | Symbol - second leg of spread order |
| expiryDateLeg2 | string | Expiry Date - second leg of spread order |
| strikePriceLeg2 | number | Strike Price - second leg of spread order |
| callPutLeg2 | string | Call / Put - second leg of spread order: Call, Put |
| buySellLeg2 | BSAction | Buy/Sell Type - second leg of spread order: Buy, Sell |
| priceType | FutOptPriceType | Original Order Price Type: Limit, Market, RangeMarket, Reference |
| price | number | Order Price |
| lot | number | Original Order Lot |
| timeInForce | TimeInforce | Time In Force: ROD, FOK, IOC |
| orderType | FutOptOrderType | Order Type: New, Close, Auto, FdayTrade |
| isPreOrder | bool | Reservation Order Flag |
| status | number | Order Status: 0 Reservation, 4 InQueue, 9 TimeOut, 10 New Order, 30 Cancel Order, 50 Fully Filled, 90 Order Failed |
| afterPriceType | FutOptPriceType | Effective Order Price Type: Limit, Market, RangeMarket, Reference |
| afterPrice | number | Effective Order Price |
| afterLot | number | Effective Order Lot |
| filledLot | number | Filled Lot |
| filledMoney | number | Filled Value |
| beforeLot | number | Effective Lot Before Modification |
| beforePrice | number | Effective Price Before Modification |
| userDef | string | Custom Field |
| lastTime | string | Last Modification Time |
| errorMessage | string | Error Message |
| detail | list | Order Process (returned by orderResultDetail or orderHistory) |
| >> functionType | number | Function Type: 10 New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 50 Filled, 90 Failed |
| >> modifiedTime | string | Modified Time |
| >> beforeLot | number | Original Order Lot |
| >> afterLot | number | Effective Order Lot |
| >> beforePrice | number | Original Order Price |
| >> filledMoney | number | Filled Value |
| >> afterPrice | number | Effective Order Price |
| >> errorMessage | string | Error Message |
BatchResult
BatchResult can be obtained using BatchOrderLists(accounts).
| Parameter | Type | Meaning |
|---|---|---|
| functionType | number | Function Type : 0 New, 15 Amend Price, 20 Amend Lot, 30 Cancel, 90 Failed |
| date | string | Date |
| branchNo | string | Branch Aumber |
| account | string | Account |
| batchSeqNo | string | Batch Serial Number |
FutOptModifyPrice
Modified Price Object
| Parameter | Type | Meaning |
|---|---|---|
| FutOptOrderResult | Object | FutOptOrderResult |
| price | number | The price after modification |
| PriceType | FutOptPriceType | The price type after modification : Limit, Market, RangeMarket Market with Protection Orders, Reference |
FutOptModifyLot
Modified Lot Object
| Parameter | Type | Meaning |
|---|---|---|
| FutOptOrderResult | Object | FutOptOrderResult |
| lot | number | The lot after modification |
FutOptFilledData
Filled Data Object
| Parameter | Type | Meaning |
|---|---|---|
| date | string | Filled Date |
| branchNo | string | Branch Number |
| account | string | Account |
| seqNo | string | Order serial number (only display on filled callback) |
| orderNo | string | Order Number |
| symbol | string | Symbol |
| expiryDate | string | Expiry Date |
| strikePrice | number | Strike Price |
| callPut | CallPut | Call / Put : Call, Put |
| buySell | BSAction | Buy/Sell Type : Buy, Sell |
| symbolLeg2 | string | Spread Symbol |
| expiryDateLeg2 | string | Expiry Date - Spread Order |
| strikePriceLeg2 | number | Strike Price - Spread Order |
| callPutLeg2 | CallPut | Call / Put : Call, Put |
| buySellLeg2 | BSAction | Buy/Sell Type - Spread Order: Buy, Sell |
| filledNo | string | Filled Serial Number |
| filledAvgPrice | number | Filled Average Price |
| filledLot | number | Filled Share |
| filledPrice | number | Filled Price |
| filledTime | string | Filled Time |
| userDef | string | Custom Fields (only display on filled callback) |
Account
Account Information
| Parameter | Type | Meaning |
|---|---|---|
| name | string | Customer Name |
| account | string | Account |
| branchNo | string | Branch Number |
| accountType | string | Account Type : stock, futopt |
Constants ( Corresponding Values for Returned Fields )
BSAction
Buy / Sell Type
| Name | Meaning |
|---|---|
| Buy | Buy |
| Sell | Sell |
CallPut
Call / Put Type
| Name | Meaning |
|---|---|
| Call | Call |
| Put | Put |
FutOptMarketType
Trading Session Type
| Name | Meaning |
|---|---|
| Future | Future Regular Session |
| Option | Option Regular Session |
| FutureNight | Future After-Hours |
| OptionNight | Option After-Hours |
FutOptPriceType
Price Type
| Name | Meaning |
|---|---|
| Limit | Limit |
| Market | Market |
| RangeMarket | Market with Protection Orders |
| Reference | Reference Price |
TimeInForce
Time In Force
| Name | Meaning |
|---|---|
| ROD | Rest of Day |
| FOK | Fill-or-Kill |
| IOC | Immediate-or-Cancel |
FutOptOrderType
Order Type
| Name | Meaning |
|---|---|
| New | Common Stock |
| Close | Margin |
| Auto | Short sale |
| FdayTrade | DayTrade |
functionType
Function Type
| Name | Value |
|---|---|
| New Order | 0 |
| Execute New Order | 10 |
| Amend Price | 15 |
| Amend Lot | 20 |
| Cancel Order | 30 |
market
Market Category
| Name | Value |
|---|---|
| Future, Option | TAIMEX |
status
Order Status
| Name | Value |
|---|---|
| Reservation | 0 |
| Received by the middle office | 4 (use getOrderResults to retrieve the latest status) |
| Processing reported by the exchange | 8 (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 timeout | 9 (query again later with getOrderResults, or contact your broker) |
| Order or modification succeeded | 10 (successful price or quantity modifications also return 10; inspect the returned fields to identify the modification) |
| Cancellation successful | 30 |
| Partially filled; remainder cancelled | 40 |
| Fully filled | 50 |
| Price modification failed | 19 |
| Quantity modification failed | 29 |
| Cancellation failed | 39 |
| Failed | 90 |
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
| Jan | Feb | Mar | Apr | May | Jun |
|---|---|---|---|---|---|
| A | B | C | D | E | F |
| Jul | Aug | Sep | Oct | Nov | Dec |
| G | H | I | J | K | L |
Option
Call
| Jan | Feb | Mar | Apr | May | Jun |
|---|---|---|---|---|---|
| A | B | C | D | E | F |
| Jul | Aug | Sep | Oct | Nov | Dec |
| G | H | I | J | K | L |
Put
| Jan | Feb | Mar | Apr | May | Jun |
|---|---|---|---|---|---|
| M | N | O | P | Q | R |
| Jul | Aug | Sep | Oct | Nov | Dec |
| S | T | U | V | W | X |