中文

Appendix 2: Enumeration Parameter Reference Table

Language

com.tigerbrokers.stock.openapi.client.struct.enums.Language

IdentifierLanguage
zh_CNSimplified Chinese
zh_TWTraditional Chinese
en_USEnglish

Market

com.tigerbrokers.stock.openapi.client.struct.enums.Market

IdentifierMarket
ALLAll
USUS Stocks
HKHong Kong Stocks
CNA-Shares
SGSingapore
AUAustralia
NZNew Zealand

Security Type

com.tigerbrokers.stock.openapi.client.struct.enums.SecType

IdentifierSecurity Type
STKStock
OPTUS Options
WARHK Warrants
IOPTHK CBBC
CASHForex
FUTFutures
FOPFuture Options
FUNDFund

Account Segment

com.tigerbrokers.stock.openapi.client.struct.enums.SegmentType

IdentifierSegment Type
ALLAll
SECSecurities
FUTFutures

Currency Type

com.tigerbrokers.stock.openapi.client.struct.enums.Currency

IdentifierCurrency Type
ALLAll
USDUS Dollar
HKDHong Kong Dollar
CNHChinese Yuan
SGDSingapore Dollar
AUDAustralian Dollar
JPYJapanese Yen
EUREuro
GBPBritish Pound
CADCanadian Dollar
NZDNew Zealand Dollar

Order Status

com.tigerbrokers.stock.openapi.client.struct.enums.OrderStatus

StatusStatus CodeDescription
Invalid-2Invalid status
Initial-1Order initial status
PendingCancel3Pending cancel (not available for integrated and simulated accounts)
Cancelled4Cancelled
PendingSubmit5Order submitted, for global accounts it's Submitted
Filled6Completely filled
Inactive7Inactive

The status of partially filled orders is complex. When the order status is not Filled (could be PendingSubmit, Cancelled, Invalid, or Inactive), it may still be partially filled. You can determine this by checking if the filled quantity is greater than 0.

Order Replace Status

StatusDescription
NONEDefault status or order terminated
RECEIVEDReplace request received (pretrade check passed)
REPLACEDReplace successful (confirmed by upstream)
FAILEDReplace failed (rejection received from upstream)

Order Cancel Status

StatusDescription
NONEDefault status or order terminated
RECEIVEDCancel request received (pretrade check passed)
FAILEDCancel failed (rejection received from upstream)

Account Status

com.tigerbrokers.stock.openapi.client.struct.enums.AccountStatus

StatusDescription
NewNew account
FundedFunded
OpenOpen
PendingPending
AbandonedAbandoned
RejectedRejected
ClosedClosed
UnknownUnknown

Order Type

com.tigerbrokers.stock.openapi.client.struct.enums.OrderType

TypeDescription
MKTMarket order
LMTLimit order
STPStop order
STP_LMTStop limit order
TRAILTrailing stop order
AMAuction market order (HK stocks)
ALAuction limit order (HK stocks)

Attached Order Type

com.tigerbrokers.stock.openapi.client.struct.enums.AttachType

TypeDescription
PROFITAttached profit order
LOSSAttached stop loss order
BRACKETSAttached bracket order

Trading Session

com.tigerbrokers.stock.openapi.client.struct.enums.TradingSessionType

TypeDescription
PRE_RTH_POSTIncludes pre-market, regular hours, and after-hours
OVERNIGHTOvernight session
RTHRegular trading hours
FULLFull session

Margin Account Type

TypeDescription
CASHCash account
RegTMarginReg T margin account

Asset Quote Mode

com.tigerbrokers.stock.openapi.client.struct.enums.AssetQuoteType

TypeDescription
ETHIncludes pre-market, regular hours, and after-hours quotes; uses T-1 after-hours closing price during overnight session
RTHRegular hours quotes only; uses regular hours closing price during pre-market, after-hours, and overnight sessions
OVERNIGHTIncludes overnight quotes; uses overnight quotes during overnight session

Subscription Subject

Trading subscription subjects: com.tigerbrokers.stock.openapi.client.struct.enums.Subject Quote subscription subjects: com.tigerbrokers.stock.openapi.client.struct.enums.QuoteSubject

SubjectDescription
OrderStatusOrder changes
AssetAssets
PositionPositions
QuoteStock quotes
OptionOption quotes
FutureFuture quotes
QuoteDepthStock depth quotes
TradeTickStock tick-by-tick trades

K-line Type

com.tigerbrokers.stock.openapi.client.struct.enums.KType

TypeDescription
dayDaily
weekWeekly
monthMonthly
yearYearly
min11 minute
min33 minutes
min55 minutes
min1515 minutes
min3030 minutes
min6060 minutes

Order Change

FieldDescription
idOrder ID
accountAccount number
symbolUnderlying symbol, e.g., 'AAPL', '00700', 'ES', 'CN'
expiryOnly for options, warrants, CBBC
strikeOnly for options, warrants, CBBC
rightOnly for options, warrants, CBBC
identifierUnderlying identifier. For stocks, identifier is the same as symbol. For futures, includes contract month, e.g., 'CN2201'
multiplierUnits per lot, only for futures, options, warrants, CBBC
actionBuy/sell direction. BUY means buy, SELL means sell
marketMarket. US, HK
currencyCurrency. USD for US Dollar, HKD for Hong Kong Dollar
segTypeClassification by trading type. S for stocks, C for futures
secTypeSTK Stocks, OPT Options, WAR Warrants, IOPT CBBC, CASH FOREX, FUT Futures, FOP Future Options
orderTypeOrder type. 'MKT' market order/'LMT' limit order/'STP' stop order/'STP_LMT' stop limit order/'TRAIL' trailing stop order
isLongWhether it's a long position
totalQuantityOrder quantity
totalQuantityScaleOrder quantity scale factor. If totalQuantity=111, totalQuantityScale=2, then actual totalQuantity=111*10^(-2)=1.11
filledQuantityTotal filled quantity (cumulative for orders filled in multiple transactions)
filledQuantityScaleFilled quantity scale factor
avgFillPriceAverage fill price
limitPriceLimit order price
stopPriceStop price
realizedPnlRealized P&L (only available for integrated accounts)
statusOrder Status
replaceStatusOrder Replace Status
cancelStatusOrder Cancel Status
outsideRthWhether pre-market/after-hours trading is allowed, only applies to US stocks
canModifyWhether the order can be modified
canCancelWhether the order can be cancelled
liquidationWhether it's a liquidation order
nameUnderlying name
sourceOrder source (from 'OpenApi', or other)
errorMsgError message
attrDescOrder description
commissionAndFeeTotal commission and fees
openTimeOrder placement time
timestampLast update time of order status
userMarkCustom annotation
totalCashAmountTotal order amount (for cash amount orders only)
filledCashAmountFilled amount (for cash amount orders only)

Position Change

FieldDescription
accountUser account
symbolStock symbol
expiryExpiry date - specific to options, warrants, CBBC
strikeStrike price - specific to options, warrants, CBBC
rightOption direction PUT/CALL - specific to options, warrants, CBBC
identifierUnderlying identifier
multiplierUnits per lot - specific to options, warrants, CBBC
marketTrading market
currencyCurrency type
segTypeClassification by trading type. S for stocks, C for futures
secTypeSecurity type
positionPosition
positionScalePosition quantity scale factor
averageCostAverage cost
latestPriceLatest price
marketValueMarket value
unrealizedPnlUnrealized P&L
nameUnderlying name
timestampServer time

Asset Change

FieldDescription
accountUser account
currencyCurrency type
segTypeClassification by trading type. S for stocks, C for futures
availableFundsAvailable funds (including loan value - initial margin)
excessLiquidityExcess liquidity (loan value - maintenance margin)
netLiquidationNet liquidation value
equityWithLoanEquity with loan value (loan value assets)
buyingPowerBuying power
cashBalanceAccount cash balance
grossPositionValueGross position value
initMarginReqCurrent initial margin requirement
maintMarginReqCurrent maintenance margin requirement
timestampServer time

Quote Change

  • Basic Quote
FieldSub-fieldDescription
symbolStock symbol
typeType
timestampQuote data time
serverTimestampServer time
avgPriceAverage price
latestPriceLatest price
latestPriceTimestampLatest price timestamp (not available for pre-market, after-hours)
latestTimeLatest price time
preClosePrevious close
volumeDaily cumulative volume
amountDaily cumulative trading amount (not supported for options and futures)
openOpen price
highHigh price
lowLow price
hourTradingTagPre-market/after-hours tag (not available during regular hours for US stocks), values: PreMarket/AfterHours
marketStatusMarket status, values: Trading/WaitingOpen/OpeningAuction/InAuction/ClosingAuction/Closed/MiddayBreak/AfterHoursTrading/AfterHoursMatching/ExtendedTrading/PreMarket
identifierUnderlying identifier (options only)
openIntOpen interest (options only)
tradeTimeTrading time (futures only)
preSettlementPrevious settlement price (futures only)
minTickMinimum tick size (futures only)
mipMinute latest price
miaMinute average price
mitMinute time
mivMinute volume
mioMinute open price
mihMinute high price
milMinute low price
  • Best Bid/Ask Quote
FieldDescription
askPriceAsk price
askSizeAsk size
askTimestampAsk timestamp (Pre/Post-Market data not supported)
bidPriceBid price
bidSizeBid size
bidTimestampBid timestamp (Pre/Post-Market data not supported)

Options Exchange

ExchangeDescription
AMEXNYSE MKT Options Exchange
BOXBoston Options Exchange
CBOEChicago Board of Options Exchange
EMLDMIAX Emerald
EDGXBATS EDGX
GEMISE Gemini
ISEInternational Securities Exchange
MCRYISE Mercury
MIAXMiami Options Exchange
ARCANYSE-ARCA Options Exchange
MPRLMIAX-Pearl
NSDQNASDAQ
BXNASDAQ OMX BX
C2CBOE C2 Options
PHLXPhiladelphia Options Exchange
BZXCBOE BZX / BATS Options
MEMXMEMX

Quote Permission

FieldDescription
usQuoteBasicNasdaq Basic
usStockQuoteUS Stock Quote
usStockQuoteLv2TotalviewNasdaq Basic+TotalView
hkStockQuoteLv2HK Stock L2 Depth Quote
usOptionQuoteOption L1 Real-time Quote
HKEXFuturesQuoteLv2Hong Kong Futures Exchange L2
SGXFuturesQuoteLv2Singapore Exchange Derivatives L2
OSEFuturesQuoteLv2Osaka Exchange L2
CBOEFuturesQuoteLv2Chicago Board Options Exchange L2

Order Description

DescriptionMeaning
ExerciseOption exercise
ExpiryOption expiry
AssignmentOption assignment

Tick Trade Condition Description

DescriptionMarketMeaning
US_REGULAR_SALEUSAutomatic matching
US_BUNCHED_TRADEUSBunched trade
US_CASH_TRADEUSCash trade
US_INTERMARKET_SWEEPUSIntermarket sweep
US_BUNCHED_SOLD_TRADEUSBunched sold trade
US_PRICE_VARIATION_TRADEUSPrice variation trade
US_ODD_LOT_TRADEUSOdd lot trade
US_RULE_127_OR_155_TRADEUSNYSE Rule 127 or 155 trade
US_SOLD_LASTUSSold last
US_MARKET_CENTER_CLOSE_PRICEUSMarket center close price
US_NEXT_DAY_TRADEUSNext day trade
US_MARKET_CENTER_OPENING_TRADEUSMarket center opening trade
US_PRIOR_REFERENCE_PRICEUSPrior reference price
US_MARKET_CENTER_OPEN_PRICEUSMarket center open price
US_SELLERUSSeller
US_FORM_TUSPre-market/after-hours trade
US_EXTENDED_TRADING_HOURSUSExtended trading hours
US_CONTINGENT_TRADEUSContingent trade
US_AVERAGE_PRICE_TRADEUSAverage price trade
US_CROSS_TRADEUSCross trade
US_SOLD_OUT_OF_SEQUENCEUSSold out of sequence
US_ODD_LOST_CROSS_TRADEUSOdd lot cross trade
US_DERIVATIVELY_PRICEDUSDerivatively priced
US_MARKET_CENTER_RE_OPENING_TRADEUSMarket center re-opening trade
US_MARKET_CENTER_CLOSING_TRADEUSMarket center closing trade
US_QUALIFIED_CONTINGENT_TRADEUSQualified contingent trade
US_CONSOLIDATED_LAST_PRICE_PER_LISTING_PACKETUSConsolidated last price per listing packet
HK_AUTOMATCH_NORMALHKAutomatic matching
HK_ODD_LOT_TRADEHKOdd lot trade
HK_AUCTION_TRADEHKAuction trade
HK_OVERSEAS_TRADEHKOverseas trade
HK_LATE_TRADE_OFF_EXCHGHKPre-opening trade
HK_NON_DIRECT_OFF_EXCHG_TRADEHKNon-automatic matching
HK_DIRECT_OFF_EXCHG_TRADEHKSame broker automatic matching
HK_AUTOMATIC_INTERNALIZEDHKSame broker non-automatic matching

Stock Scanner - Basic Indicator Filter Fields

public enum StockField {
    /** Stock code*, cannot fill range upper and lower limit values. */
    /** Latest price* (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_CurPrice(2, "latestPrice"),
    /** Bid price (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_BidPrice(3, "bidPrice"),
    /** Ask price (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_AskPrice(4, "askPrice"),
    /** Open price (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_OpenPrice(5, "open"),
    /** Previous close price (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_PreClosePrice(6, "preClose"),
    /** High price */
    StockField_HighPrice(7, "high"),
    /** Low price */
    StockField_LowPrice(8, "low"),
    /** Pre-market price* (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_HourTradingPrePrice(9, "hourTradingPrePrice"),
    /** After-hours price* (accurate to 3 decimal places, excess will be discarded) e.g., fill [10,20] value range */
    StockField_HourTradingAfterPrice(10, "hourTradingAfterPrice"),
    /** Volume* */
    StockField_Volume(11, "volume"),
    /** Turnover* */
    StockField_Amount(12, "amount"),
    /** Float shares* */
    StockField_FloatShare(13, "floatShares"),
    /** 52-week high price* */
    StockField_Week52High(14, "week52High"),
    /** 52-week low price* */
    StockField_Week52Low(15, "week52Low"),
    /** Float market cap* FloatMarketVal calculated by FloatShare * current price */
    StockField_FloatMarketVal(16, "floatMarketCap"),
    /** Total market cap* MarketVal = shares * current price */
    StockField_MarketValue(17, "marketValue"),
    /** Pre-market change rate calculated by (curPrice - pre-market left close) / close */
    StockField_preHourTradingChangeRate(18, "preHourTradingChangeRate"),
    /** After-hours change rate calculated automatically */
    StockField_postHourTradingChangeRate(19, "postHourTradingChangeRate"),
    /** Earnings per share Rolling P/E TTM = past 12 months Last Twelve Month obtained through hermes eps */
    StockField_ttm_Eps(20, "ttmEps"),
    /** Volume ratio* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    StockField_VolumeRatio(21, "volumeRatio"),
    /** Bid-ask ratio* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    StockField_BidAskRatio(22, "committee"),
    /** Next earnings date* */
    StockField_EarningDate(23, "earningDate"),
    /** P/E ratio* TTM (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    StockField_PeTTM(24, "peRate"),
    /** Dividend hermes $ */
    StockField_DividePrice(26, "dividePriceVal"),
    /** Dividend yield calculated by stock scanner service */
    StockField_DivideRate(27, "divideRateVal"),
    /** Stock exchange */
    StockField_Exchange(29, "exchange"),
    /** Turnover rate* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    StockField_TurnoverRate(30, "turnoverRate"),
    /** Listing date */
    StockField_ListingDate(31, "listingDate"),
    /** Total shares* */
    StockField_Share(33, "shares"),
    /** Listing price* */
    StockField_ListingPrice(34, "listingPrice"),
    /** Latest price - Issue price* */
    StockField_DiffBetweenLastPriceAndListPrice(36, "DiffBetweenLastPriceAndListPrice"),
    /** Earnings per share lyr = Last Year Ratio static P/E ratio */
    StockField_lyr_Eps(37, "lyrEps"),
    /** Open short interest */
    StockField_Open_Short_Interest(38, "OpenShortInterestVal"),
    /** Open short interest ratio = Open short interest / Total shares */
    StockField_Open_Short_Interest_Ratio(39, "OpenShortInterestRatio"),
    /** Debt-to-equity ratio = Liability/Equity Total debt/Shareholders' equity */
    StockField_Equity_Ratio(40, "totalDebtToEquity"),
    /** Equity multiplier = Asset/Equity */
    StockField_Equity_Multiplier(41, "totalLiabilitiesToTotalAssets"),
    /** Latest number of shareholders */
    StockField_Holder_Nums(42, "holderNums"),
    /** Latest shareholder count growth rate */
    StockField_Holder_Nums_Ratio(43, "holderRatio"),
    /** Average shares held per holder */
    StockField_Per_Hold_Nums(44, "perHolderNums"),
    /** Average value held per holder */
    StockField_Per_Hold_Money(45, "perHolderMoney"),
    /** Half-year growth rate of average shares held per holder */
    StockField_HalfYear_Holder_Nums_Ratio(46, "HalfYearholderRatio"),
    /** Inception date - ETF */
    StockField_InceptionDate(47, "inceptionDate"),
    /** Creation fee - ETF */
    StockField_CreationFee(48, "creationFee"),
    /** Management fee - ETF */
    StockField_ManagementFee(49, "managementFee"),
    /** Top 10 holdings percentage - ETF */
    StockField_Top10_Composition_Rate(50, "Top10CompoRate"),
    /** Top 15 holdings percentage - ETF */
    StockField_Top15_Composition_Rate(51, "Top15CompoRate"),
    /** Top 20 holdings percentage - ETF */
    StockField_Top20_Composition_Rate(52, "Top20CompoRate"),
    /** Premium/discount rate - ETF */
    StockField_DiscountPremium(53, "discountPremium"),
    /** Assets under management - Net value - ETF */
    StockField_Net_Worth_Aum(55, "aum"),
    /** Asset size - Current price - ETF */
    StockField_assetSize(56, "assetSize"),
    /** Amplitude */
    StockField_Amplitude(57, "Amplitude"),
    /** Pre-market change rate */
    StockField_Pre_ChangeRate(58, "preChangeRate"),
    /** Intraday change rate */
    StockField_current_ChangeRate(59, "curChangeRate"),
    /** After-hours change rate */
    StockField_Post_ChangeRate(60, "postChangeRate"),
    /** Holdings change - ETF */
    StockField_ETF_LastHoldingChangeDay(61, "LastHoldingChangeDay"),
    /** Number of holdings - ETF */
    StockField_ETF_HoldingCount(62, "etfHoldingCount"),
    /** Net income without period */
    StockField_Net_Income(63, "netIncomeVal"),
    ;
}

Stock Scanner - Accumulative Indicator Filter Fields

public enum AccumulateField {
    /** Change rate* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    AccumulateField_ChangeRate(1, "changeRate"),
    /** Change value* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    AccumulateField_ChangeValue(2, "changeVal"),
    /** Total liabilities growth rate */
    AccumulateField_TotalLiabilities_Ratio_Annual(3, "totalLiabilitiesRatio"),
    /** Net assets growth rate */
    AccumulateField_TotalCommonEquity_Ratio_Annual(4, "totalCommonEquityRatio"),
    /** Earnings per share year-over-year growth rate */
    AccumulateField_BasicEps_Ratio_Annual(5, "basicEpsRatio"),
    /** Net income year-over-year growth rate */
    AccumulateField_NetIncome_Ratio_Annual(6, "netIncomeRatio"),
    /** Operating income year-over-year growth rate */
    AccumulateField_OperatingIncome_Ratio_Annual(7, "opeIncomeratio"),
    /** Earnings per share */
    AccumulateField_Eps(8, "eps"),
    /** Net assets per share */
    AccumulateField_NetAsset_PerShare(9, "bookValueshare"),
    /** Net income */
    AccumulateField_Net_Income(10, "netIncome"),
    /** Operating income */
    AccumulateField_Operating_Income(11, "operatingIncome"),
    /** Total revenue */
    AccumulateField_Total_Revenue(12, "total_revenue"),
    /** ROE = Return on equity */
    AccumulateField_ROE(13, "ROE"),
    /** ROA = Return on assets */
    AccumulateField_ROA(14, "ROA"),
    /** Gross profit margin */
    AccumulateField_GrossProfitRate(17, "grossMargin"),
    /** Net profit margin* */
    AccumulateField_NetProfitRate(18, "netIncomeMargin"),
    /** Total assets* */
    AccumulateField_TotalAssets(19, "totalAssets"),
    /** Current ratio */
    AccumulateField_CurrentRatio(20, "currentRatio"),
    /** Quick ratio */
    AccumulateField_QuickRatio(21, "quickRatio"),
    /** Operating cash flow year-over-year ratio */
    AccumulateField_CashFromOpsRatio(22, "cash4OpsRatio"),
    /** Cash from investing */
    AccumulateField_CashFromInvesting(23, "cash4Invest"),
    /** Cash from financing */
    AccumulateField_CashFromFinancing(24, "cash4Finance"),
    /** Total liabilities to total assets ratio */
    AccumulateField_TotalLiabilitiesToTotalAssets(25, "allLiabAndAssets"),
    /** ROE year-over-year growth rate (T period ROE - T-1 period ROE) / T-1 period ROE * 100% */
    AccumulateField_ROE_yearOnYear_Ratio(27, "netIncomeYearOnYearRatio"),
    /** Operating profit percentage */
    AccumulateField_Operating_Profits_Ratio(28, "OperatingProfitsRatio"),
    /** Operating cash flow */
    AccumulateField_CashFromOpsVal(29, "cash4OpsVal"),
    ;
}

Stock Scanner - Financial Indicator Filter Fields

public enum FinancialField {
    /** Gross profit margin* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_GrossProfitRate(1, "grossMarginVal"),
    /** Net profit margin* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_NetProfitRate(2, "netIncomeMarginVal"),
    /** Non-GAAP net profit margin* (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_EarningsFromContOpsMargin(3, "earningsFromContOpsMargin"),
    /** Long-term debt to equity** */
    FinancialField_LongTermDebtToEquity(5, "ltDebtToEquity"),
    /** EBIT to interest expense** */
    FinancialField_EbitToInterestExp(6, "ebitToInterestExp"),
    /** Total asset turnover (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_TotalAssetTurnover(8, "totalAssetTurnover"),
    /** Accounts receivable turnover */
    FinancialField_AccountsReceivableTurnover(9, "accountsReceivableTurnover"),
    /** Inventory turnover (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_InventoryTurnover(10, "inventoryTurnover"),
    /** Current ratio (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_CurrentRatio(11, "currentRatioVal"),
    /** Quick ratio (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_QuickRatio(12, "quickRatioVal"),
    /** Return on assets Total asset return*$ TTM (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_ROATTM(13, "roa"),
    /** Return on equity$ (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_ReturnOnEquityRate(14, "roe"),
    /** Total revenue 1-year growth rate or Revenue growth rate */
    FinancialField_TotalRevenues1YrGrowth(15, "totalRevenues1YrGrowth"),
    /** Gross profit 1-year growth rate Operating profit growth rate */
    FinancialField_GrossProfit1YrGrowth(16, "grossProfit1YrGrowth"),
    /** Net income 1-year growth rate */
    FinancialField_NetIncome1YrGrowth(17, "netIncome1YrGrowth"),
    /** Accounts receivable 1-year growth rate */
    FinancialField_AccountsReceivable1YrGrowth(18, "accountsReceivable1YrGrowth"),
    /** Inventory 1-year growth rate */
    FinancialField_Inventory1YrGrowth(19, "inventory1YrGrowth"),
    /** Total assets 1-year growth rate */
    FinancialField_TotalAssets1YrGrowth(20, "totalAssets1YrGrowth"),
    /** Tangible book value 1-year growth rate */
    FinancialField_TangibleBookValue1YrGrowth(21, "tangibleBookValue1YrGrowth"),
    /** Cash from operations 1-year growth rate = Operating cash flow year-over-year growth rate */
    FinancialField_CashFromOperations1YrGrowth(22, "cashFromOperations1YrGrowth"),
    /** Capital expenditures 1-year growth rate */
    FinancialField_CapitalExpenditures1YrGrowth(23, "capitalExpenditures1YrGrowth"),
    /** Total revenue 3-year growth rate or Revenue 3-year CAGR */
    FinancialField_TotalRevenues3YrCagr(24, "totalRevenues3YrCagr"),
    /** Gross profit 3-year growth rate */
    FinancialField_GrossProfit3YrCagr(25, "grossProfit3YrCagr"),
    /** Net income 3-year growth rate */
    FinancialField_NetIncome3YrCagr(26, "netIncome3YrCagr"),
    /** Accounts receivable 3-year growth rate */
    FinancialField_AccountsReceivable3YrCagr(27, "accountsReceivable3YrCagr"),
    /** Inventory 3-year growth rate */
    FinancialField_Inventory3YrCagr(28, "inventory3YrCagr"),
    /** Total assets 3-year growth rate */
    FinancialField_TotalAssets3YrCagr(29, "totalAssets3YrCagr"),
    /** Tangible book value 3-year growth rate */
    FinancialField_TangibleBookValue3YrCagr(30, "tangibleBookValue3YrCagr"),
    /** Operating cash flow 3-year growth rate */
    FinancialField_CashFromOps3YrCagr(31, "cashFromOps3YrCagr"),
    /** Capital expenditures 3-year growth rate */
    FinancialField_CapitalExpenditures3YrCagr(32, "capitalExpenditures3YrCagr"),
    /** Net income */
    FinancialField_NetIncomeToCompany(33, "netIncomeToCompany"),
    /** Operating cash flow */
    FinancialField_CashFromOperations(34, "cashFromOps"),
    /** Cash from investing */
    FinancialField_CashFromInvesting(35, "cashFromInvesting"),
    /** Cash from financing */
    FinancialField_CashFromFinancing(36, "cashFromFinancing"),
    /** Net income 2-year CAGR */
    FinancialField_NormalizedNetIncome2YrCagr(37, "netIncome2YrCagr"),
    /** Revenue 2-year CAGR */
    FinancialField_TotalRevenues2YrCagr(38, "totalRevenues2YrCagr"),
    /** Net income 5-year CAGR */
    FinancialField_NetIncome5YrCagr(39, "netIncome5YrCagr"),
    /** Revenue 5-year CAGR */
    FinancialField_TotalRevenues5YrCagr(40, "totalRevenues5YrCagr"),
    /** Total assets */
    FinancialField_TotalAssets(41, "totalAssetsVal"),
    /** Fixed asset turnover (accurate to 3 decimal places, excess will be discarded) e.g., fill [0.005,0.01] value range */
    FinancialField_FixedAssetTurnover(42, "fixedAssetTurnover"),
    /** Operating income */
    FinancialField_OperatingIncome(43, "operatingIncomeVal"),
    /** Total revenue */
    FinancialField_TotalRevenue(44, "totalRevenue"),
    /** P/E ratio LYR PE = price-to-earnings ratio */
    FinancialField_LYR_PE(45, "LyrPE"),
    /** P/E ratio TTM PE = price-to-earnings ratio */
    FinancialField_TTM_PE(46, "ttmPE"),
    /** P/S ratio LYR PS = Price-to-sales Ratio */
    FinancialField_LYR_PS(47, "LyrPS"),
    /** P/S ratio TTM PS = Price-to-sales Ratio */
    FinancialField_TTM_PS(48, "ttmPS"),
    /** Today's large net inflow amount */
    FinancialField_LargeInflowAmountToday(49, "largeInflowAmountToday"),
    /** Today's large inflow percentage */
    FinancialField_LargeInflowAmountTodayPre(50, "largeInflowAmountTodayPre"),
    /** Short interest */
    FinancialField_ShortInterest(51, "shortInterest"),
    /** Short interest percentage */
    FinancialField_ShortInterestPre(52, "shortInterestPre"),
    /** Hong Kong Stock Connect holding ratio = Hong Kong Stock Connect (Shenzhen) holding ratio = Hong Kong Stock Connect (Shanghai) holding ratio */
    FinancialField_HK_StockConnectRate(53, "hkStockConnectRate"),
    /** Shanghai Stock Connect holding ratio */
    FinancialField_SH_StockConnectRate(54, "shStockConnectRate"),
    /** Shenzhen Stock Connect holding ratio */
    FinancialField_SZ_StockConnectRate(55, "szStockConnectRate"),
    /** Operating profit percentage */
    FinancialField_Operating_Profits_Rate(56, "operatingProfitsRate"),
    /** Hong Kong Stock Connect (Shanghai) net buying amount */
    FinancialField_HK_StockShConnectInflow(57, "hkStockShConnectInflow"),
    /** Hong Kong Stock Connect (Shenzhen) net buying amount */
    FinancialField_HK_StockSzConnectInflow(58, "hkStockSzConnectInflow"),
    /** Shanghai Stock Connect net buying amount */
    FinancialField_SH_StockConnectInflow(59, "shStockConnectInflow"),
    /** Shenzhen Stock Connect net buying amount */
    FinancialField_SZ_StockConnectInflow(60, "szStockConnectInflow"),
    /** Annualized return since listing ETF */
    FinancialField_ListingAnnualReturn(61, "listingAnnualReturn"),
    /** 1-year annualized return ETF */
    FinancialField_LstYearAnnualReturn(62, "lstYearAnnualReturn"),
    /** 2-year annualized return ETF */
    FinancialField_Lst2YearAnnualReturn(63, "lst2YearAnnualReturn"),
    /** 5-year annualized return ETF */
    FinancialField_Lst5YearAnnualReturn(64, "lst5YearAnnualReturn"),
    /** Annualized volatility since listing ETF */
    FinancialField_ListingAnnualVolatility(65, "listingAnnualVolatility"),
    /** 1-year annualized volatility ETF */
    FinancialField_LstYearAnnualVolatility(66, "lstYearAnnualVolatility"),
    /** 2-year annualized volatility ETF */
    FinancialField_Lst2YearAnnualVolatility(67, "lst2YearAnnualVolatility"),
    /** 5-year annualized volatility ETF */
    FinancialField_Lst5YearAnnualVolatility(68, "lst5YearAnnualVolatility"),
    /** P/B ratio LYR PB = price/book value ratio */
    FinancialField_LYR_PB(69, "LyrPB"),
    /** P/B ratio TTM PB = price/book value ratio */
    FinancialField_TTM_PB(70, "ttmPB"),
    ;
}

Stock Scanner - Multi-Tag Filter Fields

public enum MultiTagField {
    /** Industry */
    MultiTagField_Industry(1, "industry"),
    /** Concept */
    MultiTagField_Concept(2, "concept"),
    /** Is OTC stock. 1=yes, 0=no */
    MultiTagField_isOTC(3, "isOTC"),
    MultiTagField_StockCode(4, "symbol"),
    /** Stock type stock or etf; Stock type, non-0 indicates the stock is ETF, 1 indicates non-leveraged ETF, 2 indicates 2x leveraged ETF, 3 indicates 3x leveraged ETF, negative value indicates inverse ETF */
    MultiTagField_Type(5, "type"),
    /** Volume anomaly. 1=yes, 0=no; Daily real-time volume > 5* average volume over the past year */
    MultiTagField_Volume_Spike(6, "volSpike"),
    /** Stocks below net value; P/B ratio < 1 */
    MultiTagField_Net_Broken(7, "netBroken"),
    /** Stocks below issue price; Latest price < Issue price */
    MultiTagField_Issue_Price_Broken(8, "issuePriceBroken"),
    /** Tracking index/asset - ETF */
    MultiTagField_PrimaryBenchmark(9, "primaryBenchmark"),
    /** Issuer - ETF */
    MultiTagField_Issuer(10, "issuer"),
    /** Custodian - ETF */
    MultiTagField_Custodian(11, "custodian"),
    /** Distribution frequency - ETF */
    MultiTagField_DistributionFrequency(12, "distributionFrequency"),
    /** Options available - ETF; 1=yes, 0=no */
    MultiTagField_OptionsAvailable(13, "optionsAvailable"),
    /** Today's historical high - ETF 1=yes, 0=no */
    MultiTagField_Today_HistoryHigh(14, "todayHistoryHigh"),
    /** Today's historical low - ETF 1=yes, 0=no */
    MultiTagField_Today_HistoryLow(15, "todayHistoryLow"),
    /** Stock package */
    MultiTagField_Stock_Package(16, "StockPkg"),
    /** 52-week high 0 no 1 yes* */
    MultiTagField_Week52HighFlag(17, "week52HighFlag"),
    /** 52-week low 0 no 1 yes */
    MultiTagField_Week52LowFlag(18, "week52LowFlag"),
    /** Trading currency, requires specific currency */
    MultiTagField_TradeCurrency(19, "tradeCurrency"),
    /** ETF type, requires specific type */
    MultiTagField_ETF_TYPE(20, "etfType"),
    /** Stock market, supports multiple markets here, requires specific type QotMarket stock market, pass the value inside */
    MultiTagField_Market_Name(21, "marketName"),
    /** First-level industry level requires passing specific sectorId */
    MultiTagField_One_Sectors_Level(22, "oneSectorsLevel"),
    ;
}

Sort Direction

public enum SortDir {
    SortDir_No(0),
    SortDir_Ascend(1),
    SortDir_Descend(2);
}