Skip to main content

List of Enumerations

Class

Class

Condition Object

ParameterTypeMeaning
market_typeTradingTypeMonitor Type Valid in : Reference Reference to order object、Scheduled Time
symbolstringSymbol
triggerTriggerContentTrigger Condition Valid in : BidPriceAskPriceMatchedPriceTotalQuantityTime
trigger_valuestringTrigger Value
comparisonOperatorDirection Valid in : GreaterThanOrEqualLessThanOrEqualGreaterThanLessThan
info
  1. When Reference, trigger can match BidPriceAskPriceMatchedPriceTotalQuantity
  2. When selecting Scheduled, symbol should filled the symbolId to be triggered, and trigger must be Time.

FutOptConditionOrder Object

ParameterTypeMeaning
buy_sellBSActionBuy/Sell Type valid in BuySell
symbolstringSymbol
pricestringOrder Price
quantityintOrder Quantity
market_typeFutOptConditionMarketTypeTrading Session valid in FutureOptionFutureNightOptionNight (IMPORTANT: The following condition order functions do not support after-hours session: 1. Time slice, 2. Trail profit, 3. Time triggered conditions)
price_typeFutOptConditionPriceTypePrice Type valid in : LimitLimitUpLimitDownMarket BidPrice Bid Price、AskPrice Ask Price、Reference Reference Price (Flat Price)、MatchedPrice current market price 、RangeMarket
time_in_forceTimeInForceTime In Force valid in RodFokIoc
order_typeFutOptConditionOrderTypeOrder Type valid in : NewClose
caution

The following condition order functions do not support after-hours session:

  1. Time slice
  2. Trail profit
  3. Time triggered conditions

FutOptTPSLOrder Object

ParameterTypeMeaning
time_in_forceTimeInforceTime In Force valid in : RODFOKIOC
price_typeFutOptConditionPriceTypePrice Type valid in : LimitLimitUpLimitDownMarket BidPrice Bid Price、AskPrice Ask Price、Reference Reference Price (Flat Price)、MatchedPrice current market price 、RangeMarket
order_typeFutOptConditionOrderTypeOrder Type valid in : NewClose
target_pricestringTake Profit / Stop Loss Trigger Price
pricestringTake Profit / Stop Loss Order Price
trigger (reserved field)TriggerContentAdded since v2.2.0. No actual function yet.
info

When priceType equals limit , should fill in price; Otherwise, price equals empty string ""

FutOptTPSLWrapper Object

ParameterTypeMeaning
stop_signStopSignStop Condition : Valid Full Until Fully filled、Partial Once Filled happened 、 UntilEnd Until Expiry
tpFutOptTPSLOrder Object (Optional)TP Object
slFutOptTPSLOrder Object (Optional)SL Object
end_datestring (Optional : null equals Condition startDate)TP / SL EndDate
day_tradebool (Optional)When Fully Filled Execuate DayTrade (Fixed to True for futures)

FutOptTrailOrder

ParameterTypeMeaning
symbolstringsymbol
pricestringActivate Price
directionDirectionDirection : Valid UpDown
tick_numintUp / down tick
buy_sellBSActionBuy / Sell Type : Valid BuySell
lotintOrder lot
Price_typeFutOptConditionPriceTypePriceType : Valid BidPrice Bid Price、AskPrice Ask Price、MatchedPrice Current Price、MarketLimitUpLimitDownReference Flat Price、RangeMarket Market with Protection Orders
diffintBuy / Sell Ticker Count (Base on PriceType ) ,Positive value indicates upward increments、Negative value indicates downward decrements
time_in_forceTimeInForceTime In Force Valid RODFOKIOC
order_typeFutOptConditionOrderTypeOrderType Valid New Open Position、Close Close Position

SplitDescription

ParameterTypeMeaning
methodSliceTypeSlice Condition : Valid in :
Type1 Starting from start_time, send one order every interval seconds, for total_quantity, with single_quantity shares per order
Type2 Starting from start_time , send one order every interval seconds, for total_quantity. The remaining shares will be aggregated and included in the last order
Type3 Starting from start_time , send one order every interval seconds, for total_quantity. Distribute the remaining shares starting from the last order backwards.

intervalintervalThe Interval Between Orders
single_quantityintSingle Order Shares
total_quantityint (Optional)Total Order Shares
start_timestringStart Time
end_timestring (Optional)End Time
caution

totalQuantity must be greater than single_quantity.

ConditionOrderResult

ParameterTypeMeaning
guidstringCondition Order Serial Number

Constants ( Corresponding Values for Returned Fields )

BsAction

NameMeaning
BuyBuy
SellSell

MarketType

Trading Session Type

NameMeaning
CommonRegular Session
FixingFixing Session
IntradayOddIntraday Odd Lot
OddOdd
EmgEmerging Stock Market
EmgOddEmerging Stock Market (share Unit )

TradingType

NameMeaning
ReferenceReference to order object
IndexIndex
ScheduledTime

TriggerContent

NameMeaning
BidPriceBid Price
AskPriceSell Price
MatchedPriceMatched Price
TotalQuantityTotal Quantity
TimeTime
LimitUpLimit Up
LimitDownLimit Down
ReferencePriceReference Price

Operator

NameMeaning
GreaterThanOrEqualGreater Than or Equal
LessThanOrEqualLess Than or Equal
GreaterThanGreater Than
LessThanLess Than

StopSign

NameMeaning
FullUntil Fully Filled
PartialOnce Filled Happen
UntilEndUntil Expiry

Direction

Take Profit trace up / down/ (direction)

NameMeaning
UpUp
DownDown

SliceType

NameMeaning
Type1Starting from start_time, send one order every interval seconds, for total_quantity, with single_quantity shares per order
Type2Starting from start_time , send one order every interval seconds, for total_quantity. The remaining shares will be aggregated and included in the last order
Type3Starting from start_time , send one order every interval seconds, for total_quantity. Distribute the remaining shares starting from the last order backwards

TimeInForce

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

FutOptConditionMarketType

MarketType (FutOptConditionMarketType)

NameMeaning
FutureFuture (day session)
OptionOption (day session)

FutOptConditionPriceType

PriceType (FutOptConditionPriceType)

NameMeaning
LimitLimit
BidPriceBid Price
AskPriceAsk Price
MarketMarket Price
MatchedPriceCurrent Price
LimitUpLimit Up
LimitDownLimit Down
ReferenceReference Price (Flat Price)
RangeMarketMarket with Protection Orders

FutOptConditionOrderType

OrderType (FutOptConditionOrderType)

NameMeaning
NewOpen Position
CloseClose Position

ConditionStatus

NameMeaning
Type1Query Today's Working Condition Order
Type2Valid Orders Remaining
Type3Condition Matching
Type4Order Processing
Type5Order Successful
Type6Notified
Type7Order Failed
Type8Filled
Type9Delete Successful
Type10Exception
Type11Expired

HistoryStatus

NameMeaning
Type1All condition orders (excluding deleted and expired)
Type2Fully filled within the selected period
Type3Partial filled within the selected period
Type4Canceled within the selected period
Type5Expired within the selected period
Type6Triggered records within the selected period