Enumerations

About 16 min

Language

tigeropen.common.consts.Language sourceopen in new window

NameLanuguage
zh_CNSimplified Chinese
zh_TWTraditional Chinese
en_USEnglish

Market

tigeropen.common.consts.Market sourceopen in new window

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

Security Type

TigerOpenAPI.Common.Enum.SecType

NameAsset
STKStocks
OPTOptions
WARWarrants
IOPTCBBC
CASHFOREX
FUTFutures
FOPFuture Options
FUNDFund

Currency

TigerOpenAPI.Common.Enum.Currency

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

TigerOpenAPI.Common.Enum.OrderStatus

IdentifierStatus ValueStatus CodeDescription
EXPIREDInvalid-2Illegal state
NEWInitial-1Order initial status
PENDING_CANCELPendingCancel3Pending cancellation
CANCELLEDCancelled4Cancelled
HELDSubmitted5Order Submitted
FILLEDFilled6Completed
REJECTEDInactive7Inactive
HELDPendingSubmit8Pending Submit

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

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

Order Types

TigerOpenAPI.Common.Enum.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

TigerOpenAPI.Common.Enum.AttachType

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

Asset Account Category

TypeDescription
SECSecurities
FUTFutures

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

TigerOpenAPI.Common.Enum.KLineType

Enum class|Enum value| ---|---|--- DAY|day| WEEK|week| MONTH|month| YEAR|year| ONE_MINUTE|1min| THREE_MINUTES|3min| FIVE_MINUTES|5min| TEN_MINUTES|10min| FIFTEEN_MINUTES|15min| HALF_HOUR|30min| FORTY_FIVE_MINUTES|45min| ONE_HOUR|60min| TWO_HOURS|2hour| THREE_HOURS|3hour| FOUR_HOURS|4hour| SIX_HOURS|6hour|

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
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
MEMXMEMX

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

scanner accumulate field

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

scanner financial field

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

scanner multitag field

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

sort direction

  public enum SortDir
  {
    SortDir_No = 0, // not sort
    SortDir_Ascend = 1, // sort by ascend
    SortDir_Descend = 2 // sort by descend
  }
Last update: