Enumerations

About 13 min

Language

com.tigerbrokers.stock.openapi.client.struct.enums.Language sourceopen in new window

NameLanguage
zh_CNSimplified Chinese
zh_TWTraditional Chinese
en_USEnglish

Market

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

NameMarket
ALLAll markets
USUS market
HKHong kong market
CNA shares
SGSingapore market
AUAustralia market
NZNew zealand market

Contract Type

com.tigerbrokers.stock.openapi.client.struct.enums.SecType sourceopen in new window

NameAsset
STKStocks
OPTOptions
WARWarrants
IOPTCBBC
CASHFOREX
FUTFutures
FOPFuture Options
FUNDFund

Account segments

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

NameSegement
ALLAll segments
SECSecurity
FUTFutures

Currency

com.tigerbrokers.stock.openapi.client.struct.enums.Currency sourceopen in new window

NameCurrency
ALLALL
USDU.S Dollar
HKDHongkong Dollar
CNHChinese Yuan
SGDSingapore Dollar
AUDAustralia Dollar
JPYJapanese Yuan
EUREuro
GBPPound Sterling
CADCanada Dollar
NZDNew Zealand Dollar

Order Status

com.tigerbrokers.stock.openapi.client.struct.enums.OrderStatus sourceopen in new window

Status ValueStatus CodeDescription
Invalid-2Illegal state
Initial-1Order initial status
PendingCancel3Pending cancellation
Cancelled4Cancelled
PendingSubmitted5Order Submitted
Filled6Completed
Inactive7Inactive

The status of partially filled orders is more complicated. When the order status is not Filled (possibly one of PendingSubmit, Canceled, Invalid, and Inactive), it may be partially filled, which can be judged by whether the order volume is greater than 0

Order Replace Status

StatusDescription
NONEdefault or finished
RECEIVEDreplace request is received
REPLACEDreplace request is success
FAILEDfailed

Order Cancel Status

StatusDescription
NONEdefault or finished
RECEIVEDcancel request is received
FAILEDfailed

Account Status

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

StatusDescription
NewNew account
FundedAccount has been funded
OpenAccount has been opened
PendingPending confirmation
AbandonedAbandoned account
RejectedRejected
ClosedClosed account
UnknownUnkown

Order Types

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)
ALAuction Limit Order(HK)

Additional Order Types

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

TypeDescription
PROFITAdditional Take Profit Order
LOSSAdditional Stop Loss Order
BRACKETSAdditional Bracket Order

Account Types

TypeDescription
CASHCash Accout
RegTMarginReg T Margin Account
PMGRNPortfolio Margin

Subscription Subject

SubjectDescription
OrderStatusChange of rrder status
AssetChange of total asset
PositionChange of position
QuoteStock quote
OptionOption quote
FutureFutures quote
QuoteDepthDepth quote

K-line Type

com.tigerbrokers.stock.openapi.client.struct.enums.KTypesourceopen in new window

Enum classEnum valueDescription
DAYdayDay Kline
WEEKweekWeek Kline
MONTHmonthMonth Kline
YEARyearYear Kline
ONE_MINUTE1minOne minute Kline
THREE_MINUTES3minThree minutes Kline
FIVE_MINUTES5minFive minutes Kline
TEN_MINUTES10minTen minutes Kline
FIFTEEN_MINUTES15minFifteen minutes Kline
HALF_HOUR30minhalf hour Kline
FORTY_FIVE_MINUTES45minforty minutes Kline
ONE_HOUR60minOne hour Kline
TWO_HOURS2hourTwo hour Kline
THREE_HOURS3hourThree hour Kline
FOUR_HOURS4hourFour hour Kline
SIX_HOURS6hourSix hour Kline

Order Change

NameDescription
idunique order id
accountuser account
symbolStock ticker symbol, exmaple: 'AAPL', '00700', 'ES', 'CN'
expiryfor options, warrant, CBBC
strikefor options, warrant, CBBC
rightfor options, warrant, CBBC
identifierasset identifier. The identifier of stocks is identical to its symbol. Futures contracts will also includes their month code. Example: 'CN2201'
multipliermultiplier for futures, options, warrants and CBBC
actionBUY or SELL
marketmarket. US, HK, etc.
currencyCurrency. USD, HKD, etc.
segTypeSecurities Category C: (Commodities Futures), S: (Securities Stocks)
secTypeSTK Stocks, OPT Options, WAR Warrants, IOPT CBBC, CASH FOREX, FUT Futures, FOP Future Options
orderTypeOrder Types,'MKT'-Market Order / 'LMT'-Limit Order / 'STP'-Stop Order / 'STP_LMT'-Stop-Limit Order / 'TRAIL'-Trailing Stop Order
isLongis long
totalQuantityOrder's quantity
totalQuantityScaletotal quantity scale
filledQuantityfilled quantity
filledQuantityScalefilled quantity scale
avgFillPriceaverage price at which the orders got filled
limitPriceLimit price, required if placing a limit order (inluding LMT and STP_LMT)
stopPriceStop price, required if placing a stop order (inluding STP and STP_LMT)
realizedPnlrealized profit and loss
statusOrder status
replaceStatusOrder replace status
cancelStatusOrder cancel status
outsideRthif trade outside regular trading hours (only applicable to U.S. market)
canModifycan modify
canCancelcan cancel
liquidationIs it a liquidation order
namesymbol name
sourceorder source(from 'OpenApi', or not)
errorMsgerror message
attrDescorder description
commissionAndFeecommission and fee
openTimetimestamp when the order is placed
timestamplast update timestamp of order status
userMarkCustom Remarks
totalCashAmountThe total cash amount of the order (only for amount orders)
filledCashAmountThe filled cash amount of the order (only for amount orders)

Postion Changes

NameDescription
accountUser account
symbolstock symbol
expiryExpiration Date_Options, Warrants, CBBCs Exclusive
strikeUnderlying price_Options, warrants, CBBCs exclusive
rightOption direction_put/call_Options, warrants, CBBCs exclusive
identifierasset identifier. The identifier of stocks is identical to its symbol. Futures contracts will also includes their month code. Example: 'CN2201'
namestock name
multiplier1_lot_exclusive for options, warrants and CBBCs
markettrading market
currencycurrency type
segTypeSecurities Category C: (Commodities Futures), S: (Securities Stocks)
secTypecontract type
positionposition
positionScaletotal position scale
averageCostaverage cost
latestPriceLatest price
marketValuemarket value
unrealizedPnlFloating profit and loss
namesymbol name
timestampTiger server time

Asset Changes

NameDescription
accountUser account
currencyCurrency type
segTypeSecurities Category C: (Commodities Futures), S: (Securities Stocks)
available_fundsAvailable funds (including loan equity_initial margin)
excessLiquidityexcess liquidity (loan value equity_maintenance margin)
netLiquidationNet Liquidation Value
equityWithLoanEquity with loan value (including loan value assets)
buyingPowerbuying power
cashBalanceAccount cash balance
grossPositionValueMarket value of positions
initMarginReqCurrent initial margin
maintMarginReqcurrent maintenance margin
timestampTiger server time

Quote Change

  • Basic quote
NamesubfieldDescription
symbolticker symbol
typeBASIC/BBO
timestampquote data time
serverTimestamptiger sever time
avgPriceaverage price
latestPricelatest price
latestPriceTimestamplatest timestamp(Pre/Post-Mkt data not support)
latestTimelatest time
preCloseclose price of last trading day
volumetrading volume
amounttrading amount(Futures and Options data not support)
openopening price
highhighest price
lowlowest price
hourTradingTagif the trade happens after hours. "PreMarket" or "AfterHours"
marketStatusmarket status:Trading/WaitingOpen/OpeningAuction/InAuction/ClosingAuction/Closed/MiddayBreak/AfterHoursTrading/AfterHoursMatching/ExtendedTrading/PreMarket
identifieridentifier,only Options support
openIntopen interest, only Options support
tradeTimelatest trad time, only Futures support
preSettlementprevious settlement price, only Futures support
minTickmin tick, only Futures support
miplast price of the minute bar
miaaverage price of the minute bar
mittimestamp
mivtrading volume of the minute bar
mioopen price of the minute bar
mihhighest price of the minute bar
millowest price of the minute bar
  • Basic quote
NameDescription
askPriceask price
askSizeask size
askTimestampask timestamp(Pre/Post-Mkt data not support)
bidPricebid price
bidSizebid size
bidTimestampbid timestamp(Pre/Post-Mkt data not support)

Options Exchange

ExchangeDescription
AMEXNYSE MKTOptions 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

Market Data Permissions

Data fieldDescription
usQuoteBasicNasdaq Basic
usStockQuoteLv2TotalviewNasdaq Basic+TotalView
hkStockQuoteLv2Honkong L2 market depth data
usOptionQuoteU.S. options L1 real time quote
CMEFuturesQuoteLv2CME futures L2
CBOTFuturesQuoteLv2CBOT futures L2
COMEXFuturesQuoteLv2COMEX futures L2
NYMEXFuturesQuoteLv2NYMEX futures L2
HKEXFuturesQuoteLv2HKEX futures L2
SGXFuturesQuoteLv2SGX futures L2
OSEFuturesQuoteLv2OSE futures L2
CBOEFuturesQuoteLv2CBOE futures L2

Options Order Status

Options Order StatusDescription
ExerciseThe contract has been exercised
ExpiryThe contract is expired
AssignmentThe contract has been assigned

Trade Condition

Trade ConditionMarketDescription
US_REGULAR_SALEUSRegular sale
US_BUNCHED_TRADEUSBunched Trade
US_CASH_TRADEUSCash Trade
US_INTERMARKET_SWEEPUSIntermarket Sweep Order
US_BUNCHED_SOLD_TRADEUSBunched Sold Trade
US_PRICE_VARIATION_TRADEUSPrice Variation Trade
US_ODD_LOT_TRADEUSOdd Lot Trade
US_RULE_127_OR_155_TRADEUSRule 127 Trade (NYSE) or Rule 155 Trade (NYSE MKT)
US_SOLD_LASTUSSold Last (Late Reporting)
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_TUSExtended Hours Trade (Form T)
US_EXTENDED_TRADING_HOURSUSExtended Trading Hours – Sold out of Sequence
US_CONTINGENT_TRADEUSContingent Trade
US_AVERAGE_PRICE_TRADEUSAverage Price Trade
US_CROSS_TRADEUSUS_CROSS_TRADE
US_SOLD_OUT_OF_SEQUENCEUSSold out of Sequence
US_ODD_LOST_CROSS_TRADEUSOdd Lost 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_NORMALHKAutomatch Normal
HK_ODD_LOT_TRADEHKOdd Lot Trade
HK_AUCTION_TRADEHKAuction Trade
HK_OVERSEAS_TRADEHKOverseas Trade
HK_LATE_TRADE_OFF_EXCHGHKLate trade off exchange
HK_NON_DIRECT_OFF_EXCHG_TRADEHKNon direct off exchange trade
HK_DIRECT_OFF_EXCHG_TRADEHKDirect off exchange trade
HK_AUTOMATIC_INTERNALIZEDHKAutomatic internalized

scanner base stock field

public enum StockField {
     /** Latest price* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range of [10,20] */
     StockField_CurPrice(2, "latestPrice"),
     /** Purchase price (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [10,20] */
     StockField_BidPrice(3, "bidPrice"),
     /** Selling price (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [10,20] */
     StockField_AskPrice(4, "askPrice"),
     /** Today's offer price (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [10,20] */
     StockField_OpenPrice(5, "open"),
     /** Yesterday's closing price (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [10,20] */
     StockField_PreClosePrice(6, "preClose"),
     /** Highest price */
     StockField_HighPrice(7, "high"),
     /** Lowest price */
     StockField_LowPrice(8, "low"),
     /** Pre-market price* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the [10,20] value range */
     StockField_HourTradingPrePrice(9, "hourTradingPrePrice"),
     /** After-hours price* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the [10,20] value range */
     StockField_HourTradingAfterPrice(10, "hourTradingAfterPrice"),
     /** Volume* */
     StockField_Volume(11, "volume"),
     /** turnover* */
     StockField_Amount(12, "amount"),
     /** Circulating share capital* */
     StockField_FloatShare(13, "floatShares"),
     /** 52 week maximum price */
     StockField_Week52High(14, "week52High"),
     /** Lowest price for 52 weeks * */
     StockField_Week52Low(15, "week52Low"),
     /** Market value* FloatMarketVal calculates FloatShare* current price */
     StockField_FloatMarketVal(16, "floatMarketCap"),
     /** total market value * MarketVal shares * current price */
     StockField_MarketValue(17, "marketValue"),
     /** Pre-market price rise and fall (curPrice-pre-market left close) self-calculated latest price-close / close */
     StockField_preHourTradingChangeRate(18, "preHourTradingChangeRate"),
     /** Calculate the after-hours rise and fall by yourself */
     StockField_postHourTradingChangeRate(19, "postHourTradingChangeRate"),
     /** Earnings per share rolling price-earnings ratio TTM=last 12 months Last Twelve Month Get eps through hermes */
     StockField_ttm_Eps(20, "ttmEps"),
     /** Quantity ratio* (accurate to 3 digits after the decimal point, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     StockField_VolumeRatio(21, "volumeRatio"),
     /** Commission ratio* (accurate to 3 digits after the decimal point, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     StockField_BidAskRatio(22, "committee"),
     /** Next financial report date * */
     StockField_EarningDate(23, "earningDate"),
     /** Price-earnings ratio* TTM (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     StockField_PeTTM(24, "peRate"),
     /** Price-to-book ratio* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     StockField_PbRate(25, "pbRate"),
     /** Dividend hermes $ */
     StockField_DividePrice(26, "dividePrice"),
     /** Dividend yield is calculated by the stock selection service itself */
     StockField_DivideRate(27, "divideRate"),
     /** stock market */
     StockField_Exchange(29, "exchange"),
     /** Turnover rate* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     StockField_TurnoverRate(30, "turnoverRate"),
     /** Time to market */
     StockField_ListingDate(31, "listingDate"),
     /** Price-earnings ratio LYR* TTM (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     StockField_LyrPeRate(32, "LyrPeRate"),
     /** Total share capital* */
     StockField_Share(33, "shares"),
     /** listing price* */
     StockField_ListingPrice(34, "listingPrice"),
     /** Transaction currency* */
     StockField_TradeCurrency(35, "tradeCurrency"),
     /** Latest price - issue price* */
     StockField_DiffBetweenLastPriceAndListPrice(36, "DiffBetweenLastPriceAndListPrice"),
     /** Earnings per share lyr=Last Year Ratio static price-earnings ratio */
     StockField_lyr_Eps(37, "lyrEps"),
     /** Open short position */
     StockField_Open_Short_Interest(38, "OpenShortInterest"),
     /** Open short position ratio = open short position volume / total equity */
     StockField_Open_Short_Interest_Ratio(39, "OpenShortInterestRatio"),
     /** Equity Ratio = Liability/Equity Total Liabilities/Shareholders */
     StockField_Equity_Ratio(40, "EquityRatio"),
     /** Equity multiplier = Asset/Equity */
     StockField_Equity_Multiplier(41, "EquityMultiplier"),
     /** The latest number of shareholders */
     StockField_Holder_Nums(42, "holderNums"),
     /** The latest growth rate of the number of shareholders */
     StockField_Holder_Nums_Ratio(43, "holderRatio"),
     /** The average number of shares held by each account */
     StockField_Per_Hold_Nums(44, "perHolderNums"),
     /** The average amount of shares held by each account */
     StockField_Per_Hold_Money(45, "perHolderMoney"),
     /** Semi-annual growth rate of the average number of shares held by each account */
     StockField_HalfYear_Holder_Nums_Ratio(46, "HalfYearholderRatio"),
     /** Issue time - ETF */
     StockField_InceptionDate(47, "inceptionDate"),
     /** Purchase fee - ETF */
     StockField_CreationFee(48, "creationFee"),
     /** Management Fee - ETF */
     StockField_ManagementFee(49, "managementFee"),
     /** Proportion of top 10 constituent stocks - ETF */
     StockField_Top10_Composition_Rate(50, "Top10CompoRate"),
     /** Proportion of Top 15 Constituent Stocks - ETF */
     StockField_Top15_Composition_Rate(51, "Top15CompoRate"),
     /** Proportion of Top 20 Constituent Stocks - ETF */
     StockField_Top20_Composition_Rate(52, "Top20CompoRate"),
     /** Premium rate (discount rate) - ETF */
     StockField_DiscountPremium(53, "discountPremium"),
     /** Dividend Yield - ETF */
     StockField_dividend_Rate(54, "dividendRate"),
     /** asset size - net worth - 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-market change rate */
     StockField_Post_ChangeRate(60, "postChangeRate"),
     /** Component change - ETF */
     StockField_ETF_LastHoldingChangeDay(61, "LastHoldingChangeDay"),
     /** Holding count - ETF */
     StockField_ETF_HoldingCount(62, "etfHoldingCount"),
     /** Net income without cycle */
     StockField_Net_Income(63, "netIncomeVal"),
     ;
}

scanner accumulate field


public enum AccumulateField {
     /** Change rate* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     AccumulateField_ChangeRate(1, "changeRate"),
     /** Change amount* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     AccumulateField_ChangeValue(2, "change"),
     /** total debt growth rate */
     AccumulateField_TotalLiabilities_Ratio_Annual(3, "totalLiabilitiesRatio"),
     /** Net asset growth rate */
     AccumulateField_TotalCommonEquity_Ratio_Annual(4, "totalCommonEquityRatio"),
     /** Year-on-year growth rate of earnings per share */
     AccumulateField_BasicEps_Ratio_Annual(5, "basicEpsRatio"),
     /** Year-on-year growth rate of net profit */
     AccumulateField_NetIncome_Ratio_Annual(6, "netIncomeRatio"),
     /** Operating profit year-on-year growth rate */
     AccumulateField_OperatingIncome_Ratio_Annual(7, "opeIncomeratio"),
     /** EPS */
     AccumulateField_Eps(8, "eps"),
     /** Net assets per share */
     AccumulateField_NetAsset_PerShare(9, "bookValueshare"),
     /** net profit */
     AccumulateField_Net_Income(10, "netIncome"),
     /** operating profit */
     AccumulateField_Operating_Income(11, "operatingIncome"),
     /** Operating income */
     AccumulateField_Total_Revenue(12, "total_revenue"),
     /** ROE = return on assets */
     AccumulateField_ROE(13, "ROE"),
     /** ROA = return on equity */
     AccumulateField_ROA(14, "ROA"),
     /** Dividend hermes $ */
     AccumulateField_DividePrice(15, "dividePrice"),
     /** Dividend yield is calculated by the stock selection service itself */
     AccumulateField_DivideRate(16, "divideRate"),
     /** Gross profit margin */
     AccumulateField_GrossProfitRate(17, "grossMargin"),
     /** Net interest rate* */
     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 */
     AccumulateField_CashFromOps(22, "cash4Ops"),
     /** Investment cash flow */
     AccumulateField_CashFromInvesting(23, "cash4Invest"),
     /** Funding cash flow */
     AccumulateField_CashFromFinancing(24, "cash4Finance"),
     /** Assets and liabilities */
     AccumulateField_TotalLiabilitiesToTotalAssets(25, "allLiabAndAssets"),
     /** Year-on-year growth rate of operating cash flow; (CFO of period T-CFO of period T-1)/CFO of period T-1 *100% */
     AccumulateField_CashFromOps_yearOnYear_Ratio(26, "cash4OpsYearOnYearRatio"),
     /** Return on net assets ROE year-on-year growth rate (T period ROE-T-1 period ROE)/T-1 period ROE *100%*/
     AccumulateField_ROE_yearOnYear_Ratio(27, "netIncomeYearOnYearRatio"),
     ;
}

scanner financial field


public enum FinancialField {
     /** Gross profit margin* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_GrossProfitRate(1, "grossMargin"),
     /** Net interest rate* (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_NetProfitRate(2, "netIncomeMargin"),
     /** Deduction of non-net profit margin * (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_EarningsFromContOpsMargin(3, "earningsFromContOpsMargin"),
     /** Total Liabilities/Shareholders' Equity* (Unit: Yuan) */
     FinancialField_TotalDebtToEquity(4, "totalDebtToEquity"),
     /** Long-Term Liabilities/Shareholders' Equity **/
     FinancialField_LongTermDebtToEquity(5, "ltDebtToEquity"),
     /** EBIT/Interest expense **/
     FinancialField_EbitToInterestExp(6, "ebitToInterestExp"),
     /** Total Liabilities/Total Assets **/
     FinancialField_TotalLiabilitiesToTotalAssets(7, "totalLiabilitiesToTotalAssets"),
     /** Total asset turnover (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_TotalAssetTurnover(8, "totalAssetTurnover"),
     /** Accounts receivable turnover rate */
     FinancialField_AccountsReceivableTurnover(9, "accountsReceivableTurnover"),
     /** Inventory turnover rate (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_InventoryTurnover(10, "inventoryTurnover"),
     /** Current ratio (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_CurrentRatio(11, "currentRatio"),
     /** Quick ratio (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_QuickRatio(12, "quickRatio"),
     /** Return on assets Total return on assets *$ TTM (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_ROATTM(13, "roa"),
     /** ROE $ (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_ReturnOnEquityRate(14, "roe"),
     /** One-year growth rate of operating income or revenue growth rate */
     FinancialField_TotalRevenues1YrGrowth(15, "totalRevenues1YrGrowth"),
     /** Gross profit margin annual growth rate Operating profit growth rate */
     FinancialField_GrossProfit1YrGrowth(16, "grossProfit1YrGrowth"),
     /** Net profit annual growth rate */
     FinancialField_NetIncome1YrGrowth(17, "netIncome1YrGrowth"),
     /** Annual growth rate of accounts receivable */
     FinancialField_AccountsReceivable1YrGrowth(18, "accountsReceivable1YrGrowth"),
     /** Inventory annual growth rate */
     FinancialField_Inventory1YrGrowth(19, "inventory1YrGrowth"),
     /** Annual growth rate of total assets */
     FinancialField_TotalAssets1YrGrowth(20, "totalAssets1YrGrowth"),
     /** Annual growth rate of tangible assets */
     FinancialField_TangibleBookValue1YrGrowth(21, "tangibleBookValue1YrGrowth"),
     /** Operating cash flow annual growth rate */
     FinancialField_CashFromOperations1YrGrowth(22, "cashFromOperations1YrGrowth"),
     /** Capex annual growth rate */
     FinancialField_CapitalExpenditures1YrGrowth(23, "capitalExpenditures1YrGrowth"),
     /** Three-year growth rate of operating income or 3-year compound growth rate of revenue */
     FinancialField_TotalRevenues3YrCagr(24, "totalRevenues3YrCagr"),
     /** Three-year growth rate of gross profit margin */
     FinancialField_GrossProfit3YrCagr(25, "grossProfit3YrCagr"),
     /** Three-year growth rate of net profit */
     FinancialField_NetIncome3YrCagr(26, "netIncome3YrCagr"),
     /** Three-year growth rate of accounts receivable */
     FinancialField_AccountsReceivable3YrCagr(27, "accountsReceivable3YrCagr"),
     /** Inventory three-year growth rate */
     FinancialField_Inventory3YrCagr(28, "inventory3YrCagr"),
     /** Three-year growth rate of total assets */
     FinancialField_TotalAssets3YrCagr(29, "totalAssets3YrCagr"),
     /** Three-year growth rate of tangible assets */
     FinancialField_TangibleBookValue3YrCagr(30, "tangibleBookValue3YrCagr"),
     /** Three-year growth rate of operating cash flow */
     FinancialField_CashFromOps3YrCagr(31, "cashFromOps3YrCagr"),
     /** Three-year growth rate of capital expenditure */
     FinancialField_CapitalExpenditures3YrCagr(32, "capitalExpenditures3YrCagr"),
     /** net profit */
     FinancialField_NetIncomeToCompany(33, "netIncomeToCompany"),
     /** Operating cash flow */
     FinancialField_CashFromOperations(34, "cashFromOps"),
     /** Investment cash flow */
     FinancialField_CashFromInvesting(35, "cashFromInvesting"),
     /** Funding cash flow */
     FinancialField_CashFromFinancing(36, "cashFromFinancing"),
     /** 2-year compound growth rate of net profit */
     FinancialField_NormalizedNetIncome2YrCagr(37, "normalizedNetIncome2YrCagr"),
     /** 2-year compound growth rate of revenue */
     FinancialField_TotalRevenues2YrCagr(38, "totalRevenues2YrCagr"),
     /** 5-year compound growth rate of net profit */
     FinancialField_NetIncome5YrCagr(39, "netIncome5YrCagr"),
     /** 5-year compound growth rate of revenue */
     FinancialField_TotalRevenues5YrCagr(40, "totalRevenues5YrCagr"),
     /** Total assets */
     FinancialField_TotalAssets(41, "totalAssets"),
     /** Fixed asset turnover rate (accurate to 3 decimal places, the excess will be discarded) For example, fill in the value range [0.005,0.01] */
     FinancialField_FixedAssetTurnover(42, "fixedAssetTurnover"),
     /** operating profit */
     FinancialField_OperatingIncome(43, "operatingIncome"),
     /** Total operating income */
     FinancialField_TotalRevenue(44, "totalRevenue"),
     /** LYR PE = price-to-earnings ratio */
     FinancialField_LYR_PE(45, "LyrPE"),
     /** Price-to-earnings ratio TTM PE = price-to-earnings ratio */
     FinancialField_TTM_PE(46, "ttmPE"),
     /** Price-to-sales Ratio LYR PS =Price-to-sales Ratio */
     FinancialField_LYR_PS(47, "LyrPS"),
     /** Price-to-sales ratio TTM PS =Price-to-sales Ratio */
     FinancialField_TTM_PS(48, "ttmPS"),
     /** Price-to-book ratio LYR PB =price/book value ratio */
     FinancialField_LYR_PB(47, "LyrPB"),
     /** Price-book ratio TTM PB =price/book value ratio */
     FinancialField_TTM_PB(48, "ttmPB"),
     /** Main net inflow of the day */
     FinancialField_LargeInflowAmountToday(49, "largeInflowAmountToday"),
     /** The proportion of the main force to increase the position of the day */
     FinancialField_LargeInflowAmountTodayPre(50, "largeInflowAmountTodayPre"),
     /** Open short position */
     FinancialField_ShortInterest(51, "shortInterest"),
     /** Open short ratio */
     FinancialField_ShortInterestPre(52, "shortInterestPre"),
     /** Hong Kong Stock Connect shareholding ratio = Hong Kong Stock Connect (Shenzhen) shareholding ratio = Hong Kong Stock Connect (Shanghai) shareholding ratio */
     FinancialField_HK_StockConnectRate(53, "hkStockConnectRate"),
     /** Shanghai Stock Connect shareholding ratio */
     FinancialField_SH_StockConnectRate(54, "shStockConnectRate"),
     /** Shenzhen Stock Connect shareholding ratio */
     FinancialField_SZ_StockConnectRate(55, "szStockConnectRate"),
     /** Operating profit ratio */
     FinancialField_Operating_Profits_Rate(56, "operatingProfitsRate"),
     /** Southbound (Shanghai) net purchase amount */
     FinancialField_HK_StockShConnectInflow(57, "hkStockShConnectInflow"),
     /** Southbound (Shenzhen) net purchase amount */
     FinancialField_HK_StockSzConnectInflow(58, "hkStockSzConnectInflow"),
     /** Shanghai Stock Connect net purchase amount */
     FinancialField_SH_StockConnectInflow(59, "shStockConnectInflow"),
     /** Shenzhen Stock Connect net purchase amount */
     FinancialField_SZ_StockConnectInflow(60, "szStockConnectInflow"),
     /** Annualized rate of return ETF since listing */
     FinancialField_ListingAnnualReturn(61, "listingAnnualReturn"),
     /** Annualized rate of return ETF for the past 1 year */
     FinancialField_LstYearAnnualReturn(62, "lstYearAnnualReturn"),
     /** ETF annualized rate of return in the past 2 years */
     FinancialField_Lst2YearAnnualReturn(63, "lst2YearAnnualReturn"),
     /** ETF annualized rate of return in the past 5 years */
     FinancialField_Lst5YearAnnualReturn(64, "lst5YearAnnualReturn"),
     /** Annualized volatility ETF since listing */
     FinancialField_ListingAnnualVolatility(65, "listingAnnualVolatility"),
     /** Recent 1-year annualized volatility ETF */
     FinancialField_LstYearAnnualVolatility(66, "lstYearAnnualVolatility"),
     /** Last 2 years annualized volatility ETF */
     FinancialField_Lst2YearAnnualVolatility(67, "lst2YearAnnualVolatility"),
     /** Annualized volatility ETF in the past 5 years */
     FinancialField_Lst5YearAnnualVolatility(68, "lst5YearAnnualVolatility"),
     ;
}

scanner multitag field

public enum MultiTagField {
     /** Industry */
     MultiTagField_Industry(1, "industry"),
     /** Belonging concept */
     MultiTagField_Concept(2, "concept"),
     /** Whether it is an otc stock. 1=yes, 0=no */
     MultiTagField_isOTC(3, "isOTC"),
     MultiTagField_StockCode(4, "symbol"),
     /** Stock type stock or etf; stock type, non-0 means the stock is an ETF, 1 means etf without leverage, 2 means etf with 2 times leverage, 3 means etf with 3 times leverage, negative value means reverse ETF * /
     MultiTagField_Type(5, "type"),
     /** Trading volume is abnormal. 1=yes, 0=no; the real-time trading volume of the day> 5* the average trading volume in the last year */
     MultiTagField_Volume_Spike(6, "volSpike"),
     /** Broken net stock; price-to-book ratio PB<1 */
     MultiTagField_Net_Broken(7, "netBroken"),
     /** Broken stock; 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"),
     /** Dividend Frequency - ETF */
     MultiTagField_DistributionFrequency(12, "distributionFrequency"),
     /** Whether to support options - ETF; 1=yes, 0=no */
     MultiTagField_OptionsAvailable(13, "optionsAvailable"),
     /** Record high today - ETF 1=yes, 0=no */
     MultiTagField_Today_HistoryHigh(14, "todayHistoryHigh"),
     /** Record low today - ETF 1=yes, 0=no */
     MultiTagField_Today_HistoryLow(15, "todayHistoryLow"),
     /** Stock package */
     MultiTagField_Stock_Package(16, "StockPkg"),
     /** 52 weeks maximum 0 no 1 yes* */
     MultiTagField_Week52HighFlag(17, "week52HighFlag"),
     /** 52 weeks minimum 0 no 1 yes */
     MultiTagField_Week52LowFlag(18, "week52LowFlag"),
     ;
}

sort direction

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