Enum Parameters

The enums below come from the C# SDK's TigerOpenAPI.Common.Enum namespace.

The SDK uses two shapes: plain enum types, and type-safe enum classes built from public static readonly members. For the latter the member name differs from the value sent on the wire: KLineType.min1 is sent as 1min, and the wire value is what the API expects.

NONE is the unset default and is normally not passed as a request parameter.

Language

TigerOpenAPI.Common.Enum.Language

Member
`None`
`en_US`
`zh_CN`
`zh_TW`

Market

TigerOpenAPI.Common.Enum.Market

Member
`NONE`
`ALL`
`US`
`HK`
`SG`
`AU`
`CN`
`NZ`
`UK`

Security Type

TigerOpenAPI.Common.Enum.SecType

Member
`NONE`
`STK`
`OPT`
`WAR`
`IOPT`
`CASH`
`FUT`
`FOP`
`FUND`
`MLEG`
`FOREX`

Account Segment

TigerOpenAPI.Common.Enum.SegmentType

Member
`NONE`
`SEC`
`FUT`
`FUND`

Currency

TigerOpenAPI.Common.Enum.Currency

Member
`NONE`
`USD`
`HKD`
`CNH`
`SGD`
`AUD`
`JPY`
`EUR`
`GBP`
`CAD`
`NZD`

Order Status

TigerOpenAPI.Common.Enum.OrderStatus

Member	Number
`NONE`	0
`Invalid`	-2
`Initial`	-1
`PendingCancel`	3
`Cancelled`	4
`Submitted`	5
`Filled`	6
`Inactive`	7
`PendingSubmit`	8

Order Type

TigerOpenAPI.Common.Enum.OrderType

Member
`NONE`
`MKT`
`LMT`
`STP`
`STP_LMT`
`TRAIL`
`AM`
`AL`
`TWAP`
`VWAP`
`ICEBERG`

Attached Order Type

TigerOpenAPI.Common.Enum.AttachType

Member
`NONE`
`PROFIT`
`LOSS`
`BRACKETS`

Time in Force

TigerOpenAPI.Common.Enum.TimeInForce

Member
`NONE`
`DAY`
`GTC`
`GTD`
`OPG`

Trading Session

TigerOpenAPI.Common.Enum.TradingSessionType

Member
`PRE_RTH_POST`
`OVERNIGHT`
`RTH`
`FULL`

Trade Session

TigerOpenAPI.Common.Enum.TradeSession

Member
`Regular`
`PreMarket`
`AfterHours`
`OverNight`
`All`

Asset Quote Mode

TigerOpenAPI.Common.Enum.AssetQuoteType

Member
`ETH`
`RTH`
`OVERNIGHT`

Action Type

TigerOpenAPI.Common.Enum.ActionType

Member
`NONE`
`BUY`
`SELL`

Option Right

TigerOpenAPI.Common.Enum.Right

Member
`NONE`
`CALL`
`PUT`

Adjustment Type

TigerOpenAPI.Common.Enum.RightOption

Member
`none`
`nr`
`br`

Combo Type

TigerOpenAPI.Common.Enum.ComboType

Member
`NONE`
`COVERED`
`PROTECTIVE`
`VERTICAL`
`STRADDLE`
`STRANGLE`
`CALENDAR`
`DIAGONAL`
`SYNTHETIC`
`CUSTOM`

Bar Type

TigerOpenAPI.Common.Enum.KLineType

Member	Wire value
`day`	`day`
`week`	`week`
`month`	`month`
`year`	`year`
`min1`	`1min`
`min3`	`3min`
`min5`	`5min`
`min15`	`15min`
`min30`	`30min`
`min60`	`60min`
`min120`	`120min`
`min240`	`240min`

Futures Bar Type

TigerOpenAPI.Common.Enum.FutureKType

Member	Wire value
`min1`	`min`
`min2`	`2min`
`min3`	`3min`
`min5`	`5min`
`min10`	`10min`
`min15`	`15min`
`min30`	`30min`
`min45`	`45min`
`min60`	`60min`
`hour2`	`2hour`
`hour3`	`3hour`
`hour4`	`4hour`
`hour6`	`6hour`
`day`	`day`
`week`	`week`
`month`	`month`

Options Bar Type

TigerOpenAPI.Common.Enum.OptionKType

Member	Wire value
`day`	`day`
`min1`	`1min`
`min5`	`5min`
`min30`	`30min`
`min60`	`60min`

Timeline Type

TigerOpenAPI.Common.Enum.TimeLineType

Member
`none`
`day5`
`day`

Capital Period

TigerOpenAPI.Common.Enum.CapitalPeriod

Member	Wire value
`intraday`	`intraday`
`day`	`day`
`week`	`week`
`month`	`month`
`year`	`year`
`quarter`	`quarter`
`halfayear`	`6month`

Accumulative Period

TigerOpenAPI.Common.Enum.AccumulatePeriod

Member	Wire value
`Five_Minutes`	`_5_min`
`Five_Days`	`_5_days`
`Ten_Days`	`_10_days`
`Twenty_Days`	`_20_days`
`Beginning_Of_The_Year_To_Now`	`_1_year`
`Half_Year`	`_half_year`
`Last_Year`	`_last_year`
`Last_Two_Year`	`_last_two_year`
`Last_Five_Year`	`_last_five_year`
`Listing_Date_To_Now`	`_ListDateToNow`
`ANNUAL`	`_annu`
`QUARTERLY`	`_quart`
`QUARTERLY_Recent_Third`	`_3_ytd`
`SEMIANNUAL`	`_semiAnnu`

Financial Report Period

TigerOpenAPI.Common.Enum.FinancialPeriod

Member
`LTM`

Corporate Action Type

TigerOpenAPI.Common.Enum.CorporateActionType

Member
`NONE`
`SPLIT`
`DIVIDEND`
`EARNING`
`SYMBOL_CHANGE`
`DELISTING`
`IPO`

License

TigerOpenAPI.Common.Enum.License

Member
`NONE`
`TBNZ`
`TBSG`
`TBAU`
`TBHK`

Order Sort Field

TigerOpenAPI.Common.Enum.OrderSortBy

Member
`NONE`
`LATEST_CREATED`
`LATEST_STATUS_UPDATED`

Sort Direction

TigerOpenAPI.Common.Enum.SortDir

Member	Number
`SortDir_No`	0
`SortDir_Ascend`	1
`SortDir_Descend`	2

Fund Transfer Status

TigerOpenAPI.Common.Enum.SegmentFundStatus

Member	Number
`NONE`	0
`NEW`	1
`PROC`	2
`SUCC`	3
`FAIL`	4
`CANC`	5

Stock Status

TigerOpenAPI.Common.Enum.StockStatus

Member	Number
`UNKNOWN`	-1
`NORMAL`	0
`HALTED`	3
`DELIST`	4
`NEW`	7
`ALTER`	8

Halted Status

TigerOpenAPI.Common.Enum.HaltedStatus

Member	Number
`Normal`	0
`Suspension`	3
`Delisted`	4
`New`	7
`ALTER`	8

Warrant Type

TigerOpenAPI.Common.Enum.WarrantType

Member	Number
`All`	0
`Call`	1
`Put`	2
`Bull`	3
`Bear`	4

Warrant State

TigerOpenAPI.Common.Enum.WarrantState

Member	Number
`All`	0
`Normal`	1
`TerminateTrades`	2
`WaitingToBeListed`	3

Tick Size Type

TigerOpenAPI.Common.Enum.TickSizeType

Member
`NONE`
`CLOSED`
`OPEN_CLOSED`
`CLOSED_OPEN`
`OPEN`

Subscription Subject

TigerOpenAPI.Common.Enum.Subject

Member
`None`
`Asset`
`Position`
`OrderStatus`
`OrderTransaction`

Quote Subscription Subject

TigerOpenAPI.Common.Enum.QuoteSubject

Member
`None`
`Quote`
`Option`
`Future`
`QuoteDepth`
`TradeTick`
`StockTop`
`OptionTop`
`Kline`

Stock Ranking Indicator

TigerOpenAPI.Common.Enum.StockRankingIndicator

Member	Wire value
`ChangeRate`	`changeRate`
`ChangeRate5Min`	`changeRate5Min`
`TurnoverRate`	`turnoverRate`
`Volume`	`volume`
`Amount`	`amount`
`Amplitude`	`amplitude`

Option Ranking Indicator

TigerOpenAPI.Common.Enum.OptionRankingIndicator

Member	Wire value
`BigOrder`	`bigOrder`
`Volume`	`volume`
`Amount`	`amount`
`OpenInt`	`openInt`

Screener: Basic Fields

TigerOpenAPI.Common.Enum.StockField

Member	Wire value
`StockField_CurPrice`	`latestPrice`
`StockField_BidPrice`	`bidPrice`
`StockField_AskPrice`	`askPrice`
`StockField_OpenPrice`	`open`
`StockField_PreClosePrice`	`preClose`
`StockField_HighPrice`	`high`
`StockField_LowPrice`	`low`
`StockField_HourTradingPrePrice`	`hourTradingPrePrice`
`StockField_HourTradingAfterPrice`	`hourTradingAfterPrice`
`StockField_Volume`	`volume`
`StockField_Amount`	`amount`
`StockField_FloatShare`	`floatShares`
`StockField_Week52High`	`week52High`
`StockField_Week52Low`	`week52Low`
`StockField_FloatMarketVal`	`floatMarketCap`
`StockField_MarketValue`	`marketValue`
`StockField_preHourTradingChangeRate`	`preHourTradingChangeRate`
`StockField_postHourTradingChangeRate`	`postHourTradingChangeRate`
`StockField_ttm_Eps`	`ttmEps`
`StockField_VolumeRatio`	`volumeRatio`
`StockField_BidAskRatio`	`committee`
`StockField_EarningDate`	`earningDate`
`StockField_PeTTM`	`peRate`
`StockField_DividePrice`	`dividePriceVal`
`StockField_DivideRate`	`divideRateVal`
`StockField_Exchange`	`exchange`
`StockField_TurnoverRate`	`turnoverRate`
`StockField_ListingDate`	`listingDate`
`StockField_Share`	`shares`
`StockField_ListingPrice`	`listingPrice`
`StockField_DiffBetweenLastPriceAndListPrice`	`DiffBetweenLastPriceAndListPrice`
`StockField_lyr_Eps`	`lyrEps`
`StockField_Open_Short_Interest`	`OpenShortInterestVal`
`StockField_Open_Short_Interest_Ratio`	`OpenShortInterestRatio`
`StockField_Equity_Ratio`	`totalDebtToEquity`
`StockField_Equity_Multiplier`	`totalLiabilitiesToTotalAssets`
`StockField_Holder_Nums`	`holderNums`
`StockField_Holder_Nums_Ratio`	`holderRatio`
`StockField_Per_Hold_Nums`	`perHolderNums`
`StockField_Per_Hold_Money`	`perHolderMoney`
`StockField_HalfYear_Holder_Nums_Ratio`	`HalfYearholderRatio`
`StockField_InceptionDate`	`inceptionDate`
`StockField_CreationFee`	`creationFee`
`StockField_ManagementFee`	`managementFee`
`StockField_Top10_Composition_Rate`	`Top10CompoRate`
`StockField_Top15_Composition_Rate`	`Top15CompoRate`
`StockField_Top20_Composition_Rate`	`Top20CompoRate`
`StockField_DiscountPremium`	`discountPremium`
`StockField_Net_Worth_Aum`	`aum`
`StockField_assetSize`	`assetSize`
`StockField_Amplitude`	`Amplitude`
`StockField_Pre_ChangeRate`	`preChangeRate`
`StockField_current_ChangeRate`	`curChangeRate`
`StockField_Post_ChangeRate`	`postChangeRate`
`StockField_ETF_LastHoldingChangeDay`	`LastHoldingChangeDay`
`StockField_ETF_HoldingCount`	`etfHoldingCount`
`StockField_Net_Income`	`netIncomeVal`

Screener: Accumulative Fields

TigerOpenAPI.Common.Enum.AccumulateField

Member	Wire value
`AccumulateField_ChangeRate`	`changeRate`
`AccumulateField_ChangeValue`	`changeVal`
`AccumulateField_TotalLiabilities_Ratio_Annual`	`totalLiabilitiesRatio`
`AccumulateField_TotalCommonEquity_Ratio_Annual`	`totalCommonEquityRatio`
`AccumulateField_BasicEps_Ratio_Annual`	`basicEpsRatio`
`AccumulateField_NetIncome_Ratio_Annual`	`netIncomeRatio`
`AccumulateField_OperatingIncome_Ratio_Annual`	`opeIncomeratio`
`AccumulateField_Eps`	`eps`
`AccumulateField_NetAsset_PerShare`	`bookValueshare`
`AccumulateField_Net_Income`	`netIncome`
`AccumulateField_Operating_Income`	`operatingIncome`
`AccumulateField_Total_Revenue`	`total_revenue`
`AccumulateField_ROE`	`ROE`
`AccumulateField_ROA`	`ROA`
`AccumulateField_GrossProfitRate`	`grossMargin`
`AccumulateField_NetProfitRate`	`netIncomeMargin`
`AccumulateField_TotalAssets`	`totalAssets`
`AccumulateField_CurrentRatio`	`currentRatio`
`AccumulateField_QuickRatio`	`quickRatio`
`AccumulateField_CashFromOpsRatio`	`cash4OpsRatio`
`AccumulateField_CashFromInvesting`	`cash4Invest`
`AccumulateField_CashFromFinancing`	`cash4Finance`
`AccumulateField_TotalLiabilitiesToTotalAssets`	`allLiabAndAssets`
`AccumulateField_ROE_yearOnYear_Ratio`	`netIncomeYearOnYearRatio`
`AccumulateField_Operating_Profits_Ratio`	`OperatingProfitsRatio`
`AccumulateField_CashFromOpsVal`	`cash4OpsVal`

Screener: Financial Fields

TigerOpenAPI.Common.Enum.FinancialField

Member	Wire value
`FinancialField_GrossProfitRate`	`grossMarginVal`
`FinancialField_NetProfitRate`	`netIncomeMarginVal`
`FinancialField_EarningsFromContOpsMargin`	`earningsFromContOpsMargin`
`FinancialField_LongTermDebtToEquity`	`ltDebtToEquity`
`FinancialField_EbitToInterestExp`	`ebitToInterestExp`
`FinancialField_TotalAssetTurnover`	`totalAssetTurnover`
`FinancialField_AccountsReceivableTurnover`	`accountsReceivableTurnover`
`FinancialField_InventoryTurnover`	`inventoryTurnover`
`FinancialField_CurrentRatio`	`currentRatioVal`
`FinancialField_QuickRatio`	`quickRatioVal`
`FinancialField_ROATTM`	`roa`
`FinancialField_ReturnOnEquityRate`	`roe`
`FinancialField_TotalRevenues1YrGrowth`	`totalRevenues1YrGrowth`
`FinancialField_GrossProfit1YrGrowth`	`grossProfit1YrGrowth`
`FinancialField_NetIncome1YrGrowth`	`netIncome1YrGrowth`
`FinancialField_AccountsReceivable1YrGrowth`	`accountsReceivable1YrGrowth`
`FinancialField_Inventory1YrGrowth`	`inventory1YrGrowth`
`FinancialField_TotalAssets1YrGrowth`	`totalAssets1YrGrowth`
`FinancialField_TangibleBookValue1YrGrowth`	`tangibleBookValue1YrGrowth`
`FinancialField_CashFromOperations1YrGrowth`	`cashFromOperations1YrGrowth`
`FinancialField_CapitalExpenditures1YrGrowth`	`capitalExpenditures1YrGrowth`
`FinancialField_TotalRevenues3YrCagr`	`totalRevenues3YrCagr`
`FinancialField_GrossProfit3YrCagr`	`grossProfit3YrCagr`
`FinancialField_NetIncome3YrCagr`	`netIncome3YrCagr`
`FinancialField_AccountsReceivable3YrCagr`	`accountsReceivable3YrCagr`
`FinancialField_Inventory3YrCagr`	`inventory3YrCagr`
`FinancialField_TotalAssets3YrCagr`	`totalAssets3YrCagr`
`FinancialField_TangibleBookValue3YrCagr`	`tangibleBookValue3YrCagr`
`FinancialField_CashFromOps3YrCagr`	`cashFromOps3YrCagr`
`FinancialField_CapitalExpenditures3YrCagr`	`capitalExpenditures3YrCagr`
`FinancialField_NetIncomeToCompany`	`netIncomeToCompany`
`FinancialField_CashFromOperations`	`cashFromOps`
`FinancialField_CashFromInvesting`	`cashFromInvesting`
`FinancialField_CashFromFinancing`	`cashFromFinancing`
`FinancialField_NormalizedNetIncome2YrCagr`	`netIncome2YrCagr`
`FinancialField_TotalRevenues2YrCagr`	`totalRevenues2YrCagr`
`FinancialField_NetIncome5YrCagr`	`netIncome5YrCagr`
`FinancialField_TotalRevenues5YrCagr`	`totalRevenues5YrCagr`
`FinancialField_TotalAssets`	`totalAssetsVal`
`FinancialField_FixedAssetTurnover`	`fixedAssetTurnover`
`FinancialField_OperatingIncome`	`operatingIncomeVal`
`FinancialField_TotalRevenue`	`totalRevenue`
`FinancialField_LYR_PE`	`LyrPE`
`FinancialField_TTM_PE`	`ttmPE`
`FinancialField_LYR_PS`	`LyrPS`
`FinancialField_TTM_PS`	`ttmPS`
`FinancialField_LargeInflowAmountToday`	`largeInflowAmountToday`
`FinancialField_LargeInflowAmountTodayPre`	`largeInflowAmountTodayPre`
`FinancialField_ShortInterest`	`shortInterest`
`FinancialField_ShortInterestPre`	`shortInterestPre`
`FinancialField_HK_StockConnectRate`	`hkStockConnectRate`
`FinancialField_SH_StockConnectRate`	`shStockConnectRate`
`FinancialField_SZ_StockConnectRate`	`szStockConnectRate`
`FinancialField_Operating_Profits_Rate`	`operatingProfitsRate`
`FinancialField_HK_StockShConnectInflow`	`hkStockShConnectInflow`
`FinancialField_HK_StockSzConnectInflow`	`hkStockSzConnectInflow`
`FinancialField_SH_StockConnectInflow`	`shStockConnectInflow`
`FinancialField_SZ_StockConnectInflow`	`szStockConnectInflow`
`FinancialField_ListingAnnualReturn`	`listingAnnualReturn`
`FinancialField_LstYearAnnualReturn`	`lstYearAnnualReturn`
`FinancialField_Lst2YearAnnualReturn`	`lst2YearAnnualReturn`
`FinancialField_Lst5YearAnnualReturn`	`lst5YearAnnualReturn`
`FinancialField_ListingAnnualVolatility`	`listingAnnualVolatility`
`FinancialField_LstYearAnnualVolatility`	`lstYearAnnualVolatility`
`FinancialField_Lst2YearAnnualVolatility`	`lst2YearAnnualVolatility`
`FinancialField_Lst5YearAnnualVolatility`	`lst5YearAnnualVolatility`
`FinancialField_LYR_PB`	`LyrPB`
`FinancialField_TTM_PB`	`ttmPB`

Screener: Multi-Tag Fields

TigerOpenAPI.Common.Enum.MultiTagField

Member	Wire value
`MultiTagField_Industry`	`industry`
`MultiTagField_Concept`	`concept`
`MultiTagField_isOTC`	`isOTC`
`MultiTagField_StockCode`	`symbol`
`MultiTagField_Type`	`type`
`MultiTagField_Volume_Spike`	`volSpike`
`MultiTagField_Net_Broken`	`netBroken`
`MultiTagField_Issue_Price_Broken`	`issuePriceBroken`
`MultiTagField_PrimaryBenchmark`	`primaryBenchmark`
`MultiTagField_Issuer`	`issuer`
`MultiTagField_Custodian`	`custodian`
`MultiTagField_DistributionFrequency`	`distributionFrequency`
`MultiTagField_OptionsAvailable`	`optionsAvailable`
`MultiTagField_Today_HistoryHigh`	`todayHistoryHigh`
`MultiTagField_Today_HistoryLow`	`todayHistoryLow`
`MultiTagField_Stock_Package`	`StockPkg`
`MultiTagField_Week52HighFlag`	`week52HighFlag`
`MultiTagField_Week52LowFlag`	`week52LowFlag`
`MultiTagField_TradeCurrency`	`tradeCurrency`
`MultiTagField_ETF_TYPE`	`etfType`
`MultiTagField_Market_Name`	`marketName`
`MultiTagField_One_Sectors_Level`	`oneSectorsLevel`