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
TRAILING_STOPTrailing Stop Market
TRAILING_STOP_LIMITTrailing Stop Limit
TWAPTWAP Market Algo
TWAP_LIMITTWAP Limit Algo
VWAPVWAP Market Algo
VWAP_LIMITVWAP Limit Algo
POVPOV Market Algo (Volume participation)
POV_LIMITPOV Limit Algo
SLICERSlicer Market Algo (Slicing)
SLICER_LIMITSlicer Limit Algo
PEGPEG Market Algo
PEG_LIMITPEG Limit Algo
ICEBERG_LIMITIceberg Limit Algo

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
HKCCChina stock market
CACanada market
FUTURESFutures market
JPJapan market
KRKorea market
MYMalaysia market
AUAustralia market
FOREXForex market
PREDICTIONPrediction market (event contracts)

exchange (Exchange) ​

ValueDescription
USUS Exchange
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
KRKorea Exchange
BMSBursa Malaysia Securities
BMDBursa Malaysia Derivatives
ASXAustralian Securities Exchange
FXForex exchange
KALSHIKalshi event contract 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
GTDGood till date
IOCImmediate or cancel
FOKFill or kill. Client-set FOK is forex only.

order_class (Order Class) ​

ValueDescription
MLEGMulti-leg order

lot_type (Lot Type) ​

ValueDescription
ODDOdd lot
ROUNDRound lot (default)

Applicable to Hong Kong and Japanese stocks.

currency (Currency) ​

ValueDescription
NONEUnknown
HKDHong Kong Dollar
USDUS Dollar
CNHOffshore RMB
JPYJapanese Yen
SGDSingapore Dollar
KRWKorean Won
MYRMalaysian Ringgit
AUDAustralian Dollar

trail_type (Trailing Type) ​

ValueDescription
NONEUnknown
RATIOTrailing ratio
AMOUNTTrailing amount

position_open_type (Position Open Type) ​

Trailing stop orders only. Controls whether opening new positions is allowed.

ValueDescription
DISABLE_POSITION_OPENDisable (close only)
ENABLE_POSITION_OPENEnable

pricing_strategy (Algo Sub-order Pricing Strategy) ​

Common optional field for algo orders. Controls sub-order pricing strategy. Defaults to ADAPTIVE (neutral).

ValueDescription
ADAPTIVENeutral
GHOSTAggressive
PASSIVEConservative

layering (Algo Sub-order Layering) ​

Common optional field for algo orders. Controls sub-order placement layer count. Defaults to 3 layers.

ValueDescription
AUTOAuto
1 - 10Explicit layer count

peg_offset (PEG Sub-order Price Tracking Rule) ​

Required field for PEG algo orders. Controls how the sub-order price tracks the market quote.

ValueDescription
MID_PRICEMid price
AGGRESSIVE_ONE_TICKAggressive 1 tick
NEAR_PRICEQuote 1 tick
PASSIVE_ONE_TICKQuote 2 ticks
PASSIVE_TWO_TICKSQuote 3 ticks
PASSIVE_THREE_TICKSQuote 4 ticks
PASSIVE_FOUR_TICKSQuote 5 ticks
PASSIVE_FIVE_TICKSQuote 6 ticks
PASSIVE_SIX_TICKSQuote 7 ticks
PASSIVE_SEVEN_TICKSQuote 8 ticks
PASSIVE_EIGHT_TICKSQuote 9 ticks
PASSIVE_NINE_TICKSQuote 10 ticks

deal_status (Deal Status) ​

ValueDescription
OKNormal
CANCELLEDTransaction cancelled
CHANGEDTransaction changed

security_type (Security Type) ​

ValueDescription
STOCKStock
OPTIONOption
FUTURESFuture
FUNDFund
MULTILEG_OPTIONMulti-leg option
FOREXForex
EVENT_CONTRACTEvent contract

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
4China Stock Market
5Futures
6Singapore Market
7Crypto
8Australia Market
9Forex
10Bond
11Malaysia Market
12Canada Market
14Fund
15Japan Market
16Structured Notes
17Event Contracts
18Korea Market

security_firm (Security Firm) ​

Used in the Get Authorized Trading Accounts response.

ValueDescription
FUTUSECURITIESFutu Securities (Hong Kong)
FUTUSGMoomoo (Singapore)
FUTUINCMoomoo (US)
FUTUCAMoomoo (Canada)
FUTUMYMoomoo (Malaysia)
FUTUAUMoomoo (Australia)
FUTUJPMoomoo (Japan)

acc_type (Account Type) ​

Account type. Used in the acc_type field of the Get Authorized Trading Accounts response.

ValueDescription
cashCash account
marginMargin account
derivativeDerivative account (JP only)

asset_category (Asset Category) ​

JP only. Used in the asset_category request parameter of the Get Account Funds and Get Positions APIs.

ValueDescription
DOMESTICDomestic (Japan)
FOREIGNForeign

sub_acc_type (Sub-Account Type) ​

JP only. Sub-account type under a JP account. See sub_account.

ValueDescription
GeneralGeneral
SpecifiedSpecified
NISANISA

margin_trading_type (Margin Trading Type) ​

JP margin account only. Margin (credit) trading type.

ValueDescription
GENERALNegotiable type
STANDARDIZEDStandardized type

margin_period_type (Margin Period Type) ​

JP margin account only. Margin (credit) period type.

ValueDescription
INDEFINITEIndefinite type

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 Structure) ​

Account object returned by the Get Authorized Trading Accounts endpoint.

FieldTypeDescription
account_iduint64Trading business account ID. JSON number; do not parse with JavaScript Number when it exceeds MAX_SAFE_INTEGER.
security_firmsecurity_firmSecurity firm info
enable_marketlist[int]Supported trading markets. See enable_market
univs_account_card_numberstringUniversal account card number (16 digits)
acc_typeacc_typeAccount type
account_card_numberstringBusiness account card number (16 digits)
sub_accountslist[sub_account]JP only. Selectable sub-accounts under this account (one record per sub-account type). Only tradable sub-accounts are returned. Empty / omitted for non-JP brokers.

sub_account (Sub-Account Structure) ​

Sub-account object under a JP account, returned in the sub_accounts list of the account object.

FieldTypeDescription
sub_acc_typesub_acc_typeJP only. Sub-account type.
sub_acc_idstringSub-account id. Pass this value as sub_acc_id when placing an order.

order (Order Structure) ​

Order object returned by order query APIs.

FieldTypeDescription
sidetrd_sideTrading direction
order_typeorder_typeOrder type
order_statusorder_statusOrder status
order_idstringOrder ID
codestringSecurity code
stock_namestringSecurity name
security_typesecurity_typeInstrument type
qtystringOrder quantity
pricestringOrder price
currencycurrencyTransaction currency
create_timeuint64Create time, Unix microsecond timestamp
updated_timeuint64Last update time, Unix microsecond timestamp
dealt_qtystringDeal quantity
dealt_avg_pricestringAverage deal price
last_err_msgstringLast error description
remarkstringRemark set when placing order
time_in_forcetime_in_forceTime in force
sessiontrading_sessionTrading session
aux_pricestringTrigger price
trail_typetrail_typeTrailing type
trail_valuestringTrailing amount/ratio.
trail_spreadstringSpecify spread.
multi_leg_infomulti_leg_infoMulti-leg order info
position_open_typeposition_open_typeOpen type, only for trailing stop orders
algo_infoalgo_infoAlgo info, only for algo orders
expire_timeuint64Unix timestamp in microseconds.
sub_acc_idstringJP only. Sub-account id of the order. (Returned by the Get Authorized Trading Accounts interface)
sub_acc_typesub_acc_typeJP only. Sub-account type.
margin_trading_typemargin_trading_typeJP margin account only. Margin trading type.
margin_period_typemargin_period_typeJP margin account only. Margin period type.
exchangestringExchange

order_fill (Fill Structure) ​

Fill object returned by deal query APIs.

FieldTypeDescription
trd_sidetrd_sideTrade 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, Unix microsecond timestamp
update_timeuint64Last update time, Unix microsecond timestamp
counter_broker_idstringCounterparty broker number
counter_broker_namestringCounterparty broker name
statusdeal_statusFill status
sub_acc_idstringJP only. Sub-account id of the order. (Returned by the Get Authorized Trading Accounts interface)
sub_acc_typesub_acc_typeJP only. Sub-account type.

multi_leg_info (Multi-Leg Order Info) ​

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

FieldTypeRequiredDescription
option_strategyoption_strategyYesMulti-leg option strategy type. Required when placing a multi-leg order; optional for combo trading-info queries.
underlying_symbolstringYesUnderlying stock symbol, e.g. AAPL
underlying_stock_namestringNoUnderlying stock name (response only)
leg_infoslist[order_leg_info]YesInformation of each leg

order_leg_info (Order Leg Info) ​

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

FieldTypeRequiredDescription
leg_codestringYesLeg security code. Format: market.symbol, e.g. US.AAPL
leg_ratio_qtystringYesRatio quantity determined by greatest common factor
leg_sidetrd_sideYesDirection of each 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)
leg_security_typesecurity_typeNoLeg security type (response only)
leg_symbolstringNoLeg symbol (response only)
leg_exchangestringNoLeg exchange (response only)

direction (Cash Flow Direction) ​

Used in the direction request parameter of Get Cash Logs.

ValueMeaning
INCash inflow
OUTCash outflow

cash_log (Cash Flow) ​

Cash flow record object returned by the Get Cash Logs API.

FieldTypeDescription
transaction_namestringDescription of the cash change event (e.g., "Stock Sell Executed", "Fund Subscription")
created_timestringRecord creation time in MM/DD/YYYY HH:MM:SS format, e.g., 09/29/2026 05:53:16
cash_changestringCash change amount. Positive for inflow, negative for outflow
balancestringAccount balance after the change
symbolstringAssociated symbol without market prefix, e.g. AAPL, 00700. Use code (market.symbol, e.g. US.AAPL) when filtering requests. Empty if no associated symbol
stock_namestringAssociated symbol code and name, e.g. "AAPL Apple Inc.", not the name alone. Empty if no associated symbol

order_fee (Fee Item) ​

Fee detail object returned by the Get Order Fees API.

FieldTypeDescription
typestringFee item type name (e.g., "Commission", "Platform Fee")
amountstringFee item amount

margin_preview (Margin Preview) ​

Margin preview object returned by the Get Combo Trading Info API.

FieldTypeDescription
namestringMargin item name
inc_valuestringMargin change amount

margin_ratio (Margin Ratio Data) ​

Margin ratio object returned by the Get Margin Ratio API.

FieldTypeDescription
codestringSymbol code. Format: market.symbol
is_long_permitboolWhether margin buying is allowed
is_short_permitboolWhether short selling is allowed
short_pool_remainstringRemaining short pool
short_fee_ratestringShort selling reference rate, e.g. "0.003%"
alert_long_ratiostringMargin buying alert ratio, e.g. "130.00%"
alert_short_ratiostringShort selling alert ratio
im_long_ratiostringInitial margin ratio for long positions
im_short_ratiostringInitial margin ratio for short positions
mcm_long_ratiostringMargin call margin ratio for long positions
mcm_short_ratiostringMargin call margin ratio for short positions
mm_long_ratiostringMaintenance margin ratio for long positions
mm_short_ratiostringMaintenance margin ratio for short positions

algo_info (Algo Order Info) ​

Algo execution info in order query responses, only for algo orders. pricing_strategy and layering are common fields; sub-structures for each algo type are returned based on order type.

FieldTypeDescription
start_timeint64Algo execution start time, Unix timestamp in microseconds
end_timeint64Algo execution end time, Unix timestamp in microseconds
pricing_strategypricing_strategySub-order pricing strategy
layeringlayeringSub-order placement layer count
twaptwap_infoTWAP execution params
vwapvwap_infoVWAP execution params
povpov_infoPOV execution params
slicerslicer_infoSlicer execution params
pegpeg_infoPEG execution params
icebergiceberg_infoIceberg execution params

twap_info (TWAP Execution Info) ​

FieldTypeDescription
participation_ratestringMaximum participation rate, range 1%–99%, minimum increment 1%. String type indicates the value is a percentage; do not pass % itself, e.g. "20" means 20%

vwap_info (VWAP Execution Info) ​

FieldTypeDescription
participation_ratestringMaximum participation rate, range 1%–99%, minimum increment 1%. String type indicates the value is a percentage; do not pass % itself, e.g. "20" means 20%

pov_info (POV Execution Info) ​

FieldTypeDescription
participation_ratestringMaximum participation rate, range 1%–80% (HK / A-share Connect / futures) or 1%–99% (US stocks), minimum increment 1%. String type indicates the value is a percentage; do not pass % itself, e.g. "20" means 20%

slicer_info (Slicer Execution Info) ​

FieldTypeDescription
slice_intervalintSub-order placement interval, in seconds; must be ≥10 and ≤(end_time − start_time) in seconds. Mutually exclusive with display_qty; one of the two is required
display_qtyintSub-order one-time qty, positive integer lots. Mutually exclusive with slice_interval; one of the two is required
display_qty_varintSub-order qty randomization, integer 0–99, default 0

peg_info (PEG Execution Info) ​

FieldTypeDescription
display_qtyintSub-order one-time qty, positive integer lots
peg_offsetpeg_offsetPeg position; defaults to NEAR_PRICE
display_qty_varintSub-order qty randomization, integer 0–99, default 0

iceberg_info (Iceberg Execution Info) ​

FieldTypeDescription
display_qtyintSub-order one-time qty, positive integer lots, range 1–parent order lots
display_qty_varintSub-order qty randomization, integer 0–99, default 0