Skip to content

Naming Dictionary

Enumeration and data structure reference for all trading APIs. All enum fields and response structures in the API documentation can be found here.

trd_side (Trading Direction)

ValueDescription
NONEUnknown direction
BUYBuy
SELLSell
SELL_SHORTSell short
BUY_BACKBuy back

order_type (Order Type)

ValueDescription
NONEUnknown type
LIMITLimit orders
MARKETMarket orders
AUCTIONAt-auction market orders
AUCTION_LIMITAt-auction limit orders
STOPStop orders
STOP_LIMITStop Limit orders
MARKET_IF_TOUCHEDMarket if Touched orders
LIMIT_IF_TOUCHEDLimit if Touched orders

order_status (Order Status)

ValueDescription
NONEUnknown status
WAITING_SUBMITWaiting to submit
SUBMITTINGSubmitting
SUBMITTEDPending
FILLED_PARTPartially filled, unfilled part not cancelled
FILLED_ALLAll filled
CANCELLED_PARTPartially filled, remaining cancelled
CANCELLED_ALLAll cancelled, no transactions
FAILEDOrder failed, refused by server
DISABLEDOrder disabled
DELETEDDeleted, only unfilled orders can be deleted

trd_market (Trading Market)

ValueDescription
NONEUnknown market
HKHong Kong market
USUS market
SGSingapore market
HKCCHKCC market
CACanada market
FUTURESFutures market

exchange (Exchange)

ValueDescription
USUS Market
SEHKHong Kong Stock Exchange
SGXSingapore Exchange
SSEShanghai Stock Exchange (Shanghai-Hong Kong Stock Connect)
SZSEShenzhen Stock Exchange (Shenzhen-Hong Kong Stock Connect)
JPJapan Exchange
CACanada Exchange
CMEChicago Mercantile Exchange
CBOTChicago Board of Trade
NYMEXNew York Mercantile Exchange
COMEXCommodity Exchange
CBOEChicago Board Options Exchange
HKFEHong Kong Futures Exchange

trading_session (Trading Session)

ValueDescription
NONEUnknown
RTHRegular trading hours
RTH+Pre/Post-MktRTH + Pre/Post-Market
OVERNIGHTOnly night trading
ALL_DAYAll-day trading

Only applicable to US stocks. Market orders only support RTH.

time_in_force (Time in Force)

ValueDescription
NONEUnknown
DAYDay order
GTCGood till cancelled

order_class (Order Class)

ValueDescription
NORMALNormal single-leg order (default)
MLEGMulti-leg order

lot_type (Lot Type)

ValueDescription
ODDOdd lot
ROUNDRound lot (default)

Only applicable to Hong Kong stocks.

currency (Currency)

ValueDescription
NONEUnknown
HKDHong Kong Dollar
USDUS Dollar
CNHOffshore RMB
JPYJapanese Yen
SGDSingapore Dollar

trail_type (Trailing Type)

ValueDescription
NONEUnknown
RATIOTrailing ratio
AMOUNTTrailing amount

deal_status (Deal Status)

ValueDescription
OKNormal
CANCELLEDTransaction cancelled
CHANGEDTransaction changed

security_type (Security Type)

ValueDescription
STOCKStock
OPTIONOption
FUTURESFuture
MULTILEG_OPTIONMulti-leg option

position_side (Position Side)

ValueDescription
NONEUnknown
LONGLong position (default)
SHORTShort position

clt_risk_status (Risk Status)

ValueDescription
NONEUnknown
LEVEL1Very Safe
LEVEL2Safe
LEVEL3Safe
LEVEL4Low Risk
LEVEL5Medium Risk
LEVEL6High Risk
LEVEL7Warning
LEVEL8Margin Call
LEVEL9Margin Call

enable_market (Supported Trading Market)

Used in the Get Authorized Trading Accounts response.

ValueDescription
1Hong Kong Market
2US Market
4HKCC Market
5Futures
6Singapore Market
7Crypto
8Australia Market
9Forex
10Bond
11Malaysia Market
12Canada Market
14Fund
15Japan Market
16Structured Notes
17Event Contracts

security_firm (Security Firm)

Used in the Get Authorized Trading Accounts response.

ValueDescription
FUTUSECURITIESFutu Securities (Hong Kong)
FUTUSGmoomoo (Singapore)
FUTUINCmoomoo (US)
FUTUCAmoomoo (Canada)

option_strategy (Option Strategy)

Used in the multi_leg_info.option_strategy field for multi-leg orders.

ValueDescription
CoveredCovered
VerticalSpreadVertical Spread
StraddleStraddle
StrangleStrangle
CollarCollar
ButterflyButterfly
CondorCondor
IronButterflyIron Butterfly
IronCondorIron Condor
CalenderSpreadCalendar Spread
DiagonalSpreadDiagonal Spread
CustomizeCustomize

Account

Account object returned by the Get Authorized Trading Accounts endpoint.

FieldTypeDescription
account_idstringTrading business account ID
security_firmSecurityFirmSecurity firm info
enable_marketlist[int]Supported trading markets. See enable_market
univs_account_card_numberstringUniversal account card number (16 digits)
acc_typestringAccount type: cash / margin
account_card_numberstringBusiness account card number (16 digits)

Order

Order object returned by order query APIs.

FieldTypeDescription
sideTrdSideTrading direction
order_typeOrderTypeOrder type
order_statusOrderStatusOrder status
order_idstringOrder ID
codestringSecurity code
stock_namestringSecurity name
security_typeSecurityTypeInstrument type
qtystringOrder quantity
pricestringOrder price
currencyCurrencyTransaction currency
create_timeuint64Create time
updated_timeuint64Last update time
dealt_qtystringDeal quantity
dealt_avg_pricestringAverage deal price
last_err_msgstringLast error description
remarkstringRemark set when placing order
time_in_forceTimeInForceTime in force
sessionTradingSessionTrading session
aux_pricestringTrigger price
trail_typeTrailTypeTrailing type
trail_valuestringTrailing amount/ratio. Negative when TrdSide is SELL or SELL_SHORT.
trail_spreadstringSpecify spread. Negative when TrdSide is SELL or SELL_SHORT.
multi_leg_infolist[MultiLegInfo]Multi-leg order info

OrderFill

Fill object returned by deal query APIs.

FieldTypeDescription
trd_sideTrdSideTrade direction
deal_idstringFill identifier. Base58-encoded, up to 32 characters. Case-sensitive.
order_idstringOrder identifier
codestringStock code
stock_namestringStock name
qtystringFill quantity
pricestringFill price
create_timeuint64Creation time
updated_timeuint64Last update time
counter_broker_idintCounterparty broker number
counter_broker_namestringCounterparty broker name
statusDealStatusFill status

MultiLegInfo

Multi-leg order details used in place order requests and order responses.

FieldTypeRequiredDescription
option_strategyOptionStrategyYesMulti-leg option strategy type
underlying_symbolstringYesUnderlying stock symbol, e.g. AAPL
underlying_stock_namestringNoUnderlying stock name (response only)
leg_infoslist[OrderLegInfo]YesInformation of each leg

OrderLegInfo

Detailed information for each leg in a multi-leg order.

FieldTypeRequiredDescription
leg_symbolstringYesSpecific leg symbol
leg_exchangeExchangeYesExchange corresponding to leg symbol
leg_ratio_qtystringYesRatio quantity determined by greatest common factor
leg_sideTrdSideYesDirection of each leg
leg_security_typeSecurityTypeYesSecurity type of leg
leg_stock_namestringNoLeg stock name (response only)
leg_hp_multiplierstringNoLeg contract multiplier (response only)
leg_avg_fill_pricestringNoAverage fill price of each leg (response only)