Quotation Definitions

Cumulative Filter Properties

• Python
• Proto

StockField

• NONE

  unknown

• CHANGE_RATE

  Yield

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-10.2, 20.4]

• AMPLITUDE

  Amplitude

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [0.5, 20.6]

• VOLUME

  Average daily trading volume

  • 0 decimal place accuracy, the excess part is discarded.
  • For example, a range of [2000, 70000]

• TURNOVER

  Average daily turnover

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1400, 890000]

• TURNOVER_RATE

  Turnover rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [2, 30]

AccumulateField

enum AccumulateField
{
    AccumulateField_Unknown = 0; // unknown
    AccumulateField_ChangeRate = 1; // Yield(3 decimal place accuracy, the excess part is discarded), for example, a range of [-10.2, 20.4] (This field is in percentage form, so 20 is equivalent to 20%.)
    AccumulateField_Amplitude = 2; // Amplitude(3 decimal place accuracy, the excess part is discarded), for example, a range of [0.5, 20.6] (This field is in percentage form, so 20 is equivalent to 20%.)
    AccumulateField_Volume = 3; // Average daily trading volume(0 decimal place accuracy, the excess part is discarded), for example, a range of [2000, 70000]
    AccumulateField_Turnover = 4; // Average daily turnover(3 decimal place accuracy, the excess part is discarded), for example, a range of [1400, 890000]
    AccumulateField_TurnoverRate = 5; // Turnover rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [2, 30] (This field is in percentage form, so 20 is equivalent to 20%.)
}

Asset Types

• Python
• Proto

AssetClass

• UNKNOW

  Unknown

• STOCK

  Stocks

• BOND

  Bonds

• COMMODITY

  Commodities

• CURRENCY_MARKET

  Currency markets

• FUTURE

  Futures

• SWAP

  Swaps

AssetClass

enum AssetClass
{
    AssetClass_Unknow = 0; //Unknown
    AssetClass_Stock = 1; //Stock
    AssetClass_Bond = 2; //Bond
    AssetClass_Commodity = 3; //Commodity
    AssetClass_CurrencyMarket = 4; //Currency Market
    AssetClass_Future = 5; //Futures
    AssetClass_Swap = 6; //Swap
}

Corporate Action

• Python
• Proto

CompanyAct

enum CompanyAct
{
    CompanyAct_None = 0; //None
    CompanyAct_Split = 1; //Share split
    CompanyAct_Join = 2; //Reverse stock split
    CompanyAct_Bonus = 4; //Bonus shares
    CompanyAct_Transfer = 8; //Transfer shares
    CompanyAct_Allot = 16; //Allotment
    CompanyAct_Add = 32; //Secondary Offering
    CompanyAct_Dividend = 64; //Cash dividend
    CompanyAct_SPDividend = 128; //Special dividend
}

Dark Disk Status

• Python
• Proto

DarkStatus

• NONE

  No grey market trading

• TRADING

  Ongoing grey market trading

• END

  Grey market trading finished

DarkStatus

enum DarkStatus
{
    DarkStatus_None = 0; //No grey market trading
    DarkStatus_Trading = 1; //Ongoing grey market trading
    DarkStatus_End = 2; //Grey market trading finished
}

Financial Filter Properties

• Python
• Proto

StockField

• NONE

  unknown

• NET_PROFIT

  Net profit

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [100000000, 2500000000]

• NET_PROFIX_GROWTH

  Net profit growth rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-10, 300]

• SUM_OF_BUSINESS

  Operating income

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [100000000, 6400000000]

• SUM_OF_BUSINESS_GROWTH

  Year-on-year growth rate of operating income

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-5, 200]

• NET_PROFIT_RATE

  Net profit rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [10, 113]

• GROSS_PROFIT_RATE

  Gross profit margin

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [4, 65]

• DEBT_ASSET_RATE

  Asset-liability ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [5, 470]

• RETURN_ON_EQUITY_RATE

  Return on equity

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [20, 230]

• ROIC

  Return on invested capital

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• ROA_TTM

  Return on assets TTM

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• EBIT_TTM

  Earnings before interest and tax TTM

  • unit: yuan.
  • Only applicable to annual reports.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• EBITDA

  Earnings before interest, tax, depreciation and amortization

  • unit: yuan.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• OPERATING_MARGIN_TTM

  Operating profit margin TTM

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• EBIT_MARGIN

  EBIT margin

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• EBITDA_MARGIN

  EBITDA margin

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• FINANCIAL_COST_RATE

  Financial cost rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• OPERATING_PROFIT_TTM

  Operating profit TTM

  • unit: yuan.
  • Only applicable to annual reports.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• SHAREHOLDER_NET_PROFIT_TTM

  Net profit attributable to the parent company

  • unit: yuan.
  • Only applicable to annual reports.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• NET_PROFIT_CASH_COVER_TTM

  The proportion of cash income in profit

  • This field is in percentage form, so 20 is equivalent to 20%.
  • Only applicable to annual reports.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1.0, 60.0]

• CURRENT_RATIO

  Current ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [100, 250]

• QUICK_RATIO

  Quick ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [100, 250]

• CURRENT_ASSET_RATIO

  Liquidity rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [10, 100]

• CURRENT_DEBT_RATIO

  Current debt ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [10, 100]

• EQUITY_MULTIPLIER

  Equity multiplier

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [100, 180]

• PROPERTY_RATIO

  Equity ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [50, 100]

• CASH_AND_CASH_EQUIVALENTS

  Cash and cash equivalent

  • unit: yuan.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• TOTAL_ASSET_TURNOVER

  Total asset turnover rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [50, 100]

• FIXED_ASSET_TURNOVER

  Fixed asset turnover rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [50, 100]

• INVENTORY_TURNOVER

  Inventory turnover rate

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [50, 100]

• OPERATING_CASH_FLOW_TTM

  Operating cash flow TTM

  • unit: yuan.
  • Only applicable to annual reports.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• ACCOUNTS_RECEIVABLE

  Net accounts receivable

  • unit: yuan.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• EBIT_GROWTH_RATE

  Year-on-year growth rate of EBIT

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• OPERATING_PROFIT_GROWTH_RATE

  Year-on-year growth rate of operating profit

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• TOTAL_ASSETS_GROWTH_RATE

  Year-on-year growth rate of total assets

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• PROFIT_TO_SHAREHOLDERS_GROWTH_RATE

  Year-on-year growth rate of net profit attributed to parent company owner

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• PROFIT_BEFORE_TAX_GROWTH_RATE

  Year-on-year growth rate of total profit

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• EPS_GROWTH_RATE

  Year-on-year growth rate of EPS

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• ROE_GROWTH_RATE

  Year-on-year growth rate of ROE

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• ROIC_GROWTH_RATE

  Year-on-year growth rate of ROIC

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• NOCF_GROWTH_RATE

  Year-on-year growth rate of operating cash flow

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• NOCF_PER_SHARE_GROWTH_RATE

  Year-on-year growth rate of operating cash flow per share

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [1.0, 10.0]

• OPERATING_REVENUE_CASH_COVER

  Operating cash cover ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [10, 100]

• OPERATING_PROFIT_TO_TOTAL_PROFIT

  Operating profit ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [10, 100]

• BASIC_EPS

  Basic earnings per share

  • 3 decimal place accuracy, the excess part is discarded.
  • unit: yuan.
  • For example, a range of [0.1, 10]

• DILUTED_EPS

  Diluted earnings per share

  • 3 decimal place accuracy, the excess part is discarded.
  • unit: yuan.
  • For example, a range of [0.1, 10]

• NOCF_PER_SHARE

  Net operating cash flow per share

  • 3 decimal place accuracy, the excess part is discarded.
  • unit: yuan.
  • For example, a range of [0.1, 10]

FinancialField

enum FinancialField
{
    // Basic financial attributes
    FinancialField_Unknown = 0; // unknown
    FinancialField_NetProfit = 1; // Net profit(3 decimal place accuracy, the excess part is discarded), for example, a range of [100000000, 2500000000]
    FinancialField_NetProfitGrowth = 2; // Net profit growth rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [-10, 300] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_SumOfBusiness = 3; // Operating income(3 decimal place accuracy, the excess part is discarded), for example, a range of [100000000, 6400000000]
    FinancialField_SumOfBusinessGrowth = 4; // The year-on-year growth rate of operating income(3 decimal place accuracy, the excess part is discarded), for example, a range of [-5, 200] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_NetProfitRate = 5; // Net profit rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [10, 113] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_GrossProfitRate = 6; // Gross profit margin(3 decimal place accuracy, the excess part is discarded), for example, a range of [4, 65] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_DebtAssetsRate = 7; // Asset-liability ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [5, 470] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_ReturnOnEquityRate = 8; // Return on equity(3 decimal place accuracy, the excess part is discarded), for example, a range of [20, 230] (This field is in percentage form, so 20 is equivalent to 20%.)

    // Profitability attributes
    FinancialField_ROIC = 9; // Return on invested capital(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_ROATTM = 10; // Return on assets TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)actually corresponds to 20%. Only applicable to annual reports.)
    FinancialField_EBITTTM = 11; // Earnings before interest and tax TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: yuan. Only applicable to annual reports.)
    FinancialField_EBITDA = 12; // Earnings before interest, tax, depreciation and amortization(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: yuan)
    FinancialField_OperatingMarginTTM = 13; // Operating profit margin TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_EBITMargin = 14; // EBIT margin(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_EBITDAMargin = 15; // EBITDA margin(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_FinancialCostRate = 16; // Financial cost rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_OperatingProfitTTM = 17; // Operating profit TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (Unit: Yuan. Only applicable to annual reports.)
    FinancialField_ShareholderNetProfitTTM = 18; // Net profit attributable to the parent company(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (Unit: Yuan. Only applicable to annual reports.)
    FinancialField_NetProfitCashCoverTTM = 19; // The proportion of cash income in profit(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 60.0] (This field is in percentage form, so 20 is equivalent to 20%.. Only applicable to annual reports.)

    // solvency attribute
    FinancialField_CurrentRatio = 20; // Current ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [100, 250] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_QuickRatio = 21; // Quick ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [100, 250] (This field is in percentage form, so 20 is equivalent to 20%.)

    // Debt clearing ability attribute
    FinancialField_CurrentAssetRatio = 22; // Liquidity rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [10, 100] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_CurrentDebtRatio = 23; // Current debt ratio(3 decimal place accuracy, the excess part is discarded), for example, fill in the [10, 100] value range (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_EquityMultiplier = 24; // Equity multiplier(3 decimal place accuracy, the excess part is discarded), for example, a range of [100, 180]
    FinancialField_PropertyRatio = 25; // Equity ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [50, 100] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_CashAndCashEquivalents = 26; // Cash and cash equivalent(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: yuan)

    // Operational capability attributes
    FinancialField_TotalAssetTurnover = 27; //Total asset turnover rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [50, 100] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_FixedAssetTurnover = 28; // Fixed asset turnover rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [50, 100] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_InventoryTurnover = 29; // Inventory turnover rate(3 decimal place accuracy, the excess part is discarded), for example, a range of [50, 100] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_OperatingCashFlowTTM = 30; // Operating cash flow TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: yuan. Only applicable to annual reports.)
    FinancialField_AccountsReceivable = 31; // Net accounts receivable(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] For example, a range of [1000000000,1000000000] (unit: yuan)

    // Growth ability attributes
    FinancialField_EBITGrowthRate = 32; // Year-on-year growth rate of EBIT(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_OperatingProfitGrowthRate = 33; // Year-on-year growth rate of operating profit(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_TotalAssetsGrowthRate = 34; // Year-on-year growth rate of total assets(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_ProfitToShareholdersGrowthRate = 35; // Year-on-year growth rate of net profit attributable to the parent(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0,10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_ProfitBeforeTaxGrowthRate = 36; // Year-on-year growth rate of total profit(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_EPSGrowthRate = 37; // Year-on-year growth rate of EPS(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_ROEGrowthRate = 38; // Year-on-year growth rate of ROE(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_ROICGrowthRate = 39; // Year-on-year growth rate of ROIC(3 decimal place accuracy, the excess part is discarded), for example, fill in the [1.0, 10.0] value range (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_NOCFGrowthRate = 40; // Year-on-year growth rate of operating cash flow(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_NOCFPerShareGrowthRate = 41; // Year-on-year growth rate of operating cash flow per share(3 decimal place accuracy, the excess part is discarded), for example, a range of [1.0, 10.0] (This field is in percentage form, so 20 is equivalent to 20%.)

    // Cash flow attributes
    FinancialField_OperatingRevenueCashCover = 42; // Operating cash cover ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [10, 100] (This field is in percentage form, so 20 is equivalent to 20%.)
    FinancialField_OperatingProfitToTotalProfit = 43; // Operating profit ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [10, 100] (This field is in percentage form, so 20 is equivalent to 20%.)

    // Market performance attributes
    FinancialField_BasicEPS = 44; // Basic earnings per share(3 decimal place accuracy, the excess part is discarded), for example, a range of [0.1, 10] (unit: yuan)
    FinancialField_DilutedEPS = 45; // Diluted earnings per share(3 decimal place accuracy, the excess part is discarded), for example, a range of [0.1, 10] (unit: yuan)
    FinancialField_NOCFPerShare = 46; // Net operating cash flow per share(3 decimal place accuracy, the excess part is discarded), for example, a range of [0.1, 10] (unit: yuan)
}

Financial Filter Properties Period

• Python
• Proto

FinancialQuarter

• NONE

  unknown

• ANNUAL

  annual report

• FIRST_QUARTER

  First quarter report

• INTERIM

  Interim report

• THIRD_QUARTER

  Third quarter report

• MOST_RECENT_QUARTER

  Latest quarter report

FinancialQuarter

enum FinancialQuarter
{
    FinancialQuarter_Unknown = 0; // unknown
    FinancialQuarter_Annual = 1; // Annual report
    FinancialQuarter_FirstQuarter = 2; // First quarter report
    FinancialQuarter_Interim = 3; // Interim report
    FinancialQuarter_ThirdQuarter = 4; // Third quarter report
    FinancialQuarter_MostRecentQuarter = 5; // Last quarter report
}

Custom indicator attributes

• Python
• Proto

StockField

• NONE

  Unknown

• PRICE

  latest price

• MA5

  Simple moving average

• MA5

  5-day simple moving average (Not recommended)

• MA10

  10-day simple moving average (Not recommended)

• MA20

  20-day simple moving average (Not recommended)

• MA30

  30-day simple moving average (Not recommended)

• MA60

  60-day simple moving average (Not recommended)

• MA120

  120-day simple moving average (Not recommended)

• MA250

  250-day simple moving average (Not recommended)

• RSI

  RSI

  The default value of the indicator parameter is [12].

• EMA

  Exponential moving average

• EMA5

  5-day exponential moving average (Not recommended)

• EMA10

  10-day exponential moving average (Not recommended)

• EMA20

  20-day exponential moving average (Not recommended)

• EMA30

  30-day exponential moving average (Not recommended)

• EMA60

  60-day exponential moving average (Not recommended)

• EMA120

  120-day exponential moving average (Not recommended)

• EMA250

  250-day exponential moving average (Not recommended)

• KDJ_K

  K value of KDJ indicator

  Indicator parameters need to be passed according to KDJ. If not passed, the default value is [9,3,3].

• KDJ_D

  D value of KDJ indicator

  Indicator parameters need to be passed according to KDJ. If not passed, the default value is [9,3,3].

• KDJ_J

  J value of KDJ indicator

  Indicator parameters need to be passed according to KDJ. If not passed, the default value is [9,3,3].

• MACD_DIFF

  DIFF value of MACD indicator

  Indicator parameters need to be passed according to MACD. If not passed, the default value is [12,26,9].

• MACD_DEA

  DEA value of MACD indicator

  Indicator parameters need to be passed according to MACD. If not passed, the default value is [12,26,9].

• MACD

  MACD value of MACD indicator

  Indicator parameters need to be passed according to MACD. If not passed, the default value is [12,26,9].

• BOLL_UPPER

  UPPER value of BOLL indicator

  Indicator parameters need to be passed according to BOLL. If not passed, the default value is [20,2].

• BOLL_MIDDLER

  MIDDLER value of BOLL indicator

  Indicator parameters need to be passed according to BOLL. If not passed, the default value is [20,2].

• BOLL_LOWER

  LOWER value of BOLL indicator

  Indicator parameters need to be passed according to BOLL. If not passed, the default value is [20,2].

• VALUE

  Custom value (stock_field1 does not support this field)

CustomIndicatorField

enum CustomIndicatorField
{
    CustomIndicatorField_Unknown = 0; // Unknown
    CustomIndicatorField_Price = 1; // latest price 
    CustomIndicatorField_MA5 = 2; // 5-day simple moving average (Not recommended)
    CustomIndicatorField_MA10 = 3; // 10-day simple moving average (Not recommended) 
    CustomIndicatorField_MA20 = 4; // 20-day simple moving average (Not recommended)
    CustomIndicatorField_MA30 = 5; // 30-day simple moving average (Not recommended)
    CustomIndicatorField_MA60 = 6; // 60-day simple moving average (Not recommended)
    CustomIndicatorField_MA120 = 7; // 120-day simple moving average (Not recommended)
    CustomIndicatorField_MA250 = 8; // 250-day simple moving average (Not recommended)
    CustomIndicatorField_RSI = 9; // RSI. The default value of the indicator parameter is [12].
    CustomIndicatorField_EMA5 = 10; // 5-day exponential moving average (Not recommended)
    CustomIndicatorField_EMA10 = 11; // 10-day exponential moving average (Not recommended)
    CustomIndicatorField_EMA20 = 12; // 20-day exponential moving average (Not recommended)
    CustomIndicatorField_EMA30 = 13; // 30-day exponential moving average (Not recommended)
    CustomIndicatorField_EMA60 = 14; // 60-day exponential moving average (Not recommended)
    CustomIndicatorField_EMA120 = 15; // 120-day exponential moving average (Not recommended)
    CustomIndicatorField_EMA250 = 16; // 250-day exponential moving average (Not recommended)
    CustomIndicatorField_Value = 17; // Custom value (stock_field1 does not support this field)
    CustomIndicatorField_MA = 30; // Simple moving average
	CustomIndicatorField_EMA = 40; // Exponential moving average
	CustomIndicatorField_KDJ_K = 50; // K value of KDJ indicator. Indicator parameters need to be passed according to KDJ. If not passed, the default value is [9,3,3].
	CustomIndicatorField_KDJ_D = 51; // D value of KDJ indicator.Indicator parameters need to be passed according to KDJ. If not passed, the default value is [9,3,3].
	CustomIndicatorField_KDJ_J = 52; // J value of KDJ indicator. Indicator parameters need to be passed according to KDJ. If not passed, the default value is [9,3,3].	
	CustomIndicatorField_MACD_DIFF = 60; // DIFF value of MACD indicator. Indicator parameters need to be passed according to MACD. If not passed, the default value is [12,26,9].
	CustomIndicatorField_MACD_DEA = 61; // DEA value of MACD indicator. Indicator parameters need to be passed according to MACD. If not passed, the default value is [12,26,9].
	CustomIndicatorField_MACD = 62; // MACD value of MACD indicator. Indicator parameters need to be passed according to MACD. If not passed, the default value is [12,26,9].
	CustomIndicatorField_BOLL_UPPER = 70; // UPPER value of BOLL indicator. Indicator parameters need to be passed according to BOLL. If not passed, the default value is [20,2].
	CustomIndicatorField_BOLL_MIDDLER = 71; // MIDDLER value of BOLL indicator. Indicator parameters need to be passed according to BOLL. If not passed, the default value is [20,2].
	CustomIndicatorField_BOLL_LOWER = 72; // LOWER value of BOLL indicator. Indicator parameters need to be passed according to BOLL. If not passed, the default value is [20,2].
}

Indicator language type

• Python
• Proto

IndicatorLangType

• UNKNOWN

  No filter

• MYLANG

  MyLang

• PYTHON

  Python

IndicatorLangType

enum IndicatorLangType
{
	IndicatorLangType_Unknown = 0;
	IndicatorLangType_MyLang = 1;
	IndicatorLangType_Python = 2;
}

Indicator search mode

• Python
• Proto

IndicatorSearchMode

• PARTIAL

  Partial match (default)

• EXACT

  Exact match; also returns script field

IndicatorSearchMode

enum IndicatorSearchMode
{
	IndicatorSearchMode_Partial = 0; // Partial match (default)
	IndicatorSearchMode_Exact = 1;   // 完全匹配
}

Indicator parameter value type

• Python
• Proto

Possible values for the type field in indicator input value dict.

IndicatorParamValueType

enum IndicatorParamValueType
{
	IndicatorParamValueType_UNKNOWN = 0; // 未知
	IndicatorParamValueType_INT = 1;     // 整数
	IndicatorParamValueType_FLOAT = 2;   // 浮点
	IndicatorParamValueType_STRING = 3;  // 字符串
	IndicatorParamValueType_COLOR = 4;   // 颜色
	IndicatorParamValueType_SHAPE = 5;   // 形状
	IndicatorParamValueType_LINE = 6;    // 线型
	IndicatorParamValueType_BOOL = 7;    // 布尔
}

Indicator shape

• Python
• Proto

When type is SHAPE, value is the enum name string below.

IndicatorShape

enum IndicatorShape
{
	IndicatorShape_UNKNOWN = 0;       // 未知
	IndicatorShape_XCROSS = 1;        // X 形十字
	IndicatorShape_CROSS = 2;         // 十字
	IndicatorShape_CIRCLE = 3;        // 圆形
	IndicatorShape_TRIANGLE_UP = 4;   // 上三角
	IndicatorShape_TRIANGLE_DOWN = 5; // 下三角
	IndicatorShape_FLAG = 6;          // 旗帜
	IndicatorShape_ARROW_UP = 7;      // 上箭头
	IndicatorShape_ARROW_DOWN = 8;    // 下箭头
	IndicatorShape_SQUARE = 9;        // 方块
	IndicatorShape_DIAMOND = 10;      // 菱形
	IndicatorShape_LABEL_UP = 11;     // 上标签
	IndicatorShape_LABEL_DOWN = 12;   // 下标签
}

Indicator line type

• Python
• Proto

When type is LINE, value is the enum name string below.

IndicatorLineType

enum IndicatorLineType
{
	IndicatorLineType_UNKNOWN = 0;          // 未知/未指定
	IndicatorLineType_SOLID = 1;            // 实线
	IndicatorLineType_DASHED = 2;           // 虚线
	IndicatorLineType_DOT = 3;              // 点线
	IndicatorLineType_CROSS = 4;            // 交叉线
	IndicatorLineType_CIRCLE = 5;           // 圆点连线
	IndicatorLineType_HISTOGRAM = 6;        // 柱状图
	IndicatorLineType_HISTOGRAM_LINE = 7;   // 柱线混合
	IndicatorLineType_STEP = 8;             // 阶梯线
	IndicatorLineType_STEP_DIAMONDS = 9;    // 阶梯+菱形
}

Indicator parameter value

• Python
• Proto

Indicator input value dict maps to this Protobuf message; SDK converts to Python values.

IndicatorParamValue

message IndicatorParamValue
{
	optional IndicatorParamValueType type = 1;  // 值类型
	optional int64 intValue = 2;                // type=INT 时使用
	optional float floatValue = 3;              // type=FLOAT 时使用
	optional string stringValue = 4;            // type=STRING 时使用
	optional bool boolValue = 5;                // type=BOOL 时使用
	optional string colorValue = 6;             // type=COLOR 时使用，格式为 #RRGGBBAA 或 #RRGGBB
	optional IndicatorShape shapeValue = 7;     // type=SHAPE 时使用
	optional IndicatorLineType lineValue = 8;     // type=LINE 时使用
}

Indicator input parameter

• Python
• Proto

Structure of inputs elements returned by get_indicator_list.

IndicatorInputParam

message IndicatorInputParam
{
	optional int32 index = 1;                // 从 0 开始
	optional string name = 2;                // 参数名
	optional IndicatorParamValue value = 3;  // 当前值
	optional string varName = 4;             // 脚本原始变量名（如 N/P1/M），仅MyLang指标有效，Python 指标为空
}

Indicator output parameter

• Python
• Proto

Metadata for one output line; matches outputs elements in push-indicator-calc callback.

IndicatorOutputParam

message IndicatorOutputParam
{
	optional int32 index = 1;                  // 从 0 开始
	optional string name = 2;                  // 输出线名
}

Relative position

• Python
• Proto

RelativePosition

• NONE

  Unknown

• MORE

  Stock_field1 is greater than stock_field2

• LESS

  Stock_field1 is less than stock_field2

• CROSS_UP

  Stock_field1 cross over stock_field2

• CROSS_DOWN

  Stock_field1 cross below stock_field2

RelativePosition

enum RelativePosition
{
    RelativePosition_Unknown = 0; // Unknown
    RelativePosition_More = 1; // Stock_field1 is greater than stock_field2
    RelativePosition_Less = 2; // Stock_field1 is less than stock_field2
    RelativePosition_CrossUp = 3; // Stock_field1 cross over stock_field2
    RelativePosition_CrossDown = 4; // Stock_field1 cross below stock_field2
}

Pattern attributes

• Python
• Proto

PatternField

• NONE

  未知

• MA_ALIGNMENT_LONG

  MA bullish alignment (MA5 > MA10 > MA20 > MA30 > MA60 for two consecutive days, and the closing price of the day is greater than the closing price of the previous day)

• MA_ALIGNMENT_SHORT

  MA bearish alignment (MA5 < MA10 < MA20 < MA30 < MA60 for two consecutive days, and the closing price of the day is less than the closing price of the previous day)

• EMA_ALIGNMENT_LONG

  EMA bullish alignment (EMA5 > EMA10 > EMA20 > EMA30 > EMA60 for two consecutive days, and the closing price of the day is greater than the closing price of the previous day)

• EMA_ALIGNMENT_SHORT

  EMA bearish alignment (EMA5 < EMA10 < EMA20 < EMA30 < MA60 for two consecutive days, and the closing price of the day is less than the closing price of the previous day)

• RSI_GOLD_CROSS_LOW

  RSI low golden cross (short-term RSI crosses over long-term RSI below 50 (short-term RSI of the previous day is less than long-term RSI, short-term RSI of the current day is greater than long-term RSI))

• RSI_DEATH_CROSS_HIGH

  RSI high dead cross (short-term RSI crosses below long-term RSI above 50 (short-term RSI of the previous day is greater than long-term RSI, short-term RSI of the current day is less than long-term RSI))

• RSI_TOP_DIVERGENCE

  RSI top divergence (two adjacent candlestick peaks, the CLOSE of the later peak > the CLOSE of the earlier peak, the RSI12 value of the later peak < the RSI12 value of the earlier peak)

• RSI_BOTTOM_DIVERGENCE

  RSI bottom divergence (two adjacent candlestick troughs, the CLOSE of the later trough < the CLOSE of the earlier trough, the RSI12 value of the later trough > the RSI12 value of the earlier trough)

• KDJ_GOLD_CROSS_LOW

  KDJ low golden cross (D value is less than or equal to 30, and the K value of the previous day is less than the D value, and the K value of the day is greater than the D value)

• KDJ_DEATH_CROSS_HIGH

  KDJ high death cross (D value is greater than or equal to 70, and the K value of the previous day is greater than the D value, and the K value of the day is less than the D value)

• KDJ_TOP_DIVERGENCE

  KDJ top divergence (two adjacent candlestick peaks, the CLOSE of the later peak > the CLOSE of the earlier peak, the J value of the later peak < the J value of the earlier peak)

• KDJ_BOTTOM_DIVERGENCE

  KDJ bottom divergence (two adjacent candlestick troughs, the CLOSE of the later trough < the CLOSE of the earlier trough, the J value of the later trough > the J value of the earlier trough)

• MACD_GOLD_CROSS_LOW

  MACD golden cross (DIFF crosses over DEA ​​(DIFF is less than DEA of the previous day, and DIFF is greater than DEA of the current day))

• MACD_DEATH_CROSS_HIGH

  MACD dead cross (DIFF crosses below DEA (DIFF is greater than DEA of the previous day, and DIFF is less than DEA of the current day))

• MACD_TOP_DIVERGENCE

  MACD top divergence (two adjacent candlestick peaks, the CLOSE of the later peak > the CLOSE of the earlier peak, the MACD value of the later peak < the MACD value of the earlier peak)

• MACD_BOTTOM_DIVERGENCE

  MACD bottom deviation (two adjacent candlestick troughs, the CLOSE of the later trough < the CLOSE of the earlier trough, the MACD value of the later trough > the MACD value of the earlier trough)

• BOLL_BREAK_UPPER

  Break up bollinger upper bound (the stock price of the previous day was lower than the upper bound, and the stock price of the current day is greater than the upper bound)

• BOLL_BREAK_LOWER

  Break up bollinger lower bound (the stock price of the previous day was greater than the lower bound, and the stock price of the current day is less than the lower bound)

• BOLL_CROSS_MIDDLE_UP

  Cross over bollinger mid line (the stock price of the previous day was lower than the mid line, and the stock price of the current day is greater than the mid line)

• BOLL_CROSS_MIDDLE_DOWN

  Cross below bollinger mid line (the stock price of the previous day was greater than the mid line, and the stock price of the current day is less than the mid line)

PatternField

enum PatternField
{
    PatternField_Unknown = 0 ; // Unknown
    PatternField_MAAlignmentLong = 1; // MA bullish alignment (MA5 > MA10 > MA20 > MA30 > MA60 for two consecutive days, and the closing price of the day is greater than the closing price of the previous day)
    PatternField_MAAlignmentShort = 2; // MA bearish alignment (MA5 < MA10 < MA20 < MA30 < MA60 for two consecutive days, and the closing price of the day is less than the closing price of the previous day)
    PatternField_EMAAlignmentLong = 3; // EMA bullish alignment (EMA5 > EMA10 > EMA20 > EMA30 > EMA60 for two consecutive days, and the closing price of the day is greater than the closing price of the previous day)
    PatternField_EMAAlignmentShort = 4; // EMA bearish alignment (EMA5 < EMA10 < EMA20 < EMA30 < MA60 for two consecutive days, and the closing price of the day is less than the closing price of the previous day)
    PatternField_RSIGoldCrossLow = 5; // RSI low golden cross (short-term RSI crosses over long-term RSI below 50 (short-term RSI of the previous day is less than long-term RSI, short-term RSI of the current day is greater than long-term RSI))
    PatternField_RSIDeathCrossHigh = 6; // RSI high dead cross (short-term RSI crosses below long-term RSI above 50 (short-term RSI of the previous day is greater than long-term RSI, short-term RSI of the current day is less than long-term RSI))
    PatternField_RSITopDivergence = 7; // RSI top divergence (two adjacent candlestick peaks, the CLOSE of the later peak > the CLOSE of the earlier peak, the RSI12 value of the later peak < the RSI12 value of the earlier peak)
    PatternField_RSIBottomDivergence = 8; // RSI bottom divergence (two adjacent candlestick troughs, the CLOSE of the later trough < the CLOSE of the earlier trough, the RSI12 value of the later trough > the RSI12 value of the earlier trough)
    PatternField_KDJGoldCrossLow = 9; // KDJ low golden cross (D value is less than or equal to 30, and the K value of the previous day is less than the D value, and the K value of the day is greater than the D value)
    PatternField_KDJDeathCrossHigh = 10; // KDJ high death cross (D value is greater than or equal to 70, and the K value of the previous day is greater than the D value, and the K value of the day is less than the D value)
    PatternField_KDJTopDivergence = 11; // KDJ top divergence (two adjacent candlestick peaks, the CLOSE of the later peak > the CLOSE of the earlier peak, the J value of the later peak < the J value of the earlier peak)
    PatternField_KDJBottomDivergence = 12; // KDJ bottom divergence (two adjacent candlestick troughs, the CLOSE of the later trough < the CLOSE of the earlier trough, the J value of the later trough > the J value of the earlier trough)
    PatternField_MACDGoldCrossLow = 13; // MACD golden cross (DIFF crosses over DEA ​​(DIFF is less than DEA of the previous day, and DIFF is greater than DEA of the current day))
    PatternField_MACDDeathCrossHigh = 14; // MACD dead cross (DIFF crosses below DEA (DIFF is greater than DEA of the previous day, and DIFF is less than DEA of the current day))
    PatternField_MACDTopDivergence = 15; // MACD top divergence (two adjacent candlestick peaks, the CLOSE of the later peak > the CLOSE of the earlier peak, the MACD value of the later peak < the MACD value of the earlier peak)
    PatternField_MACDBottomDivergence = 16; // MACD bottom deviation (two adjacent candlestick troughs, the CLOSE of the later trough < the CLOSE of the earlier trough, the MACD value of the later trough > the MACD value of the earlier trough)
    PatternField_BOLLBreakUpper = 17; // Break up bollinger upper bound (the stock price of the previous day was lower than the upper bound, and the stock price of the current day is greater than the upper bound)
    PatternField_BOLLLower = 18; // Break up bollinger lower bound (the stock price of the previous day was greater than the lower bound, and the stock price of the current day is less than the lower bound)
    PatternField_BOLLCrossMiddleUp = 19; // Cross over bollinger mid line (the stock price of the previous day was lower than the mid line, and the stock price of the current day is greater than the mid line)
    PatternField_BOLLCrossMiddleDown = 20; // Cross below bollinger mid line (the stock price of the previous day was greater than the mid line, and the stock price of the current day is less than the mid line)
}

Watchlist Group Type

• Python
• Proto

UserSecurityGroupType

• NONE

  unknown

• CUSTOM

  Custom groups

• SYSTEM

  System groups

• ALL

  All groups

GroupType

enum GroupType
{
    GroupType_Unknown = 0; // unknown
    GroupType_Custom = 1; // Custom groups
    GroupType_System = 2; // System groups
    GroupType_All = 3; // All groupss
}

Index Option Category

• Python
• Proto

IndexOptionType

• NONE

  unknown

• NORMAL

  Ordinary index option

• SMALL

  Small Index Options

IndexOptionType

enum IndexOptionType
{
    IndexOptionType_Unknown = 0; //Unknown
    IndexOptionType_Normal = 1; //Normal index option
    IndexOptionType_Small = 2; //Small index options
}

Listing Time

• Python
• Proto

IpoPeriod

• NONE

  unknown

• TODAY

  Listed today

• TOMORROW

  To be listed tomorrow

• NEXTWEEK

  To be listed next week

• LASTWEEK

  Has been listed last week

• LASTMONTH

  Has been listed last month

IpoPeriod

enum IpoPeriod
{
    IpoPeriod_Unknow = 0; //Unknown
    IpoPeriod_Today = 1; //Listed today
    IpoPeriod_Tomorrow = 2; //To be listed tomorrow
    IpoPeriod_Nextweek = 3; //To be listed next week
    IpoPeriod_Lastweek = 4; //Has been listed last week
    IpoPeriod_Lastmonth = 5; //Has been listed last month
}

Warrant Issuer

• Python
• Proto

Issuer

• UNKNOW

  unknown

• SG

  Societe Generale

• BP

  BNP Paribas

• CS

  Credit Suisse

• CT

  Citi Bank

• EA

  The Bank of East Aisa

• GS

  Goldman Sachs

• HS

  HSBC

• JP

  JPMorgan Chase

• MB

  Macquarie Bank

• SC

  Standard Chartered Bank

• UB

  Union Bank of Switzerland

• BI

  Bank of China

• DB

  Deutsche Bank

• DC

  Daiwa Bank

• ML

  Merrill Lynch

• NM

  Nomura Bank

• RB

  Rabobank

• RS

  The Royal Bank of Scotland

• BC

  Barclays

• HT

  Haitong Bank

• VT

  Bank Vontobel

• KC

  KBC Bank

• MS

  Morgan Stanley

• GJ

  Guotai Junan

• XZ

  DBS Bank

• HU

  Huatai

• KS

  Korea Investment

• CI

  CITIC Securities

Issuer

enum Issuer
{
    Issuer_Unknow = 0; //Unknown
    Issuer_SG = 1; //Societe Generale
    Issuer_BP = 2; //BNP Paribas
    Issuer_CS = 3; //Credit Suisse
    Issuer_CT = 4; //Citi Bank
    Issuer_EA = 5; //The Bank of East Aisa
    Issuer_GS = 6; //Goldman Sachs
    Issuer_HS = 7; //HSBC
    Issuer_JP = 8; //JPMorgan Chase
    Issuer_MB = 9; //Macquarie Bank
    Issuer_SC = 10; //Standard Chartered Bank
    Issuer_UB = 11; //Union Bank of Switzerland
    Issuer_BI = 12; //Bank of China
    Issuer_DB = 13; //Deutsche Bank
    Issuer_DC = 14; //Daiwa Bank
    Issuer_ML = 15; //Merrill Lynch
    Issuer_NM = 16; //Nomura Bank
    Issuer_RB = 17; //Rabobank
    Issuer_RS = 18; //The Royal Bank of Scotland
    Issuer_BC = 19; //Barclays
    Issuer_HT = 20; //Haitong Bank
    Issuer_VT = 21; //Bank Vontobel
    Issuer_KC = 22; //KBC Bank
    Issuer_MS = 23; //Morgan Stanley
    Issuer_GJ = 24; //Guotai Junan
    Issuer_XZ = 25; //DBS Bank
    Issuer_HU = 26; //Huatai
    Issuer_KS = 27; //Korea Investment
    Issuer_CI = 28; //CITIC Securities
}

Candlestick Field

• Python
• Proto

KL_FIELD

• ALL

  All

• DATE_TIME

  Time

• HIGH

  High

• OPEN

  Open

• LOW

  Low

• CLOSE

  Close

• LAST_CLOSE

  Close of the previous K-line

• TRADE_VOL

  Volume

• TRADE_VAL

  Turnover

• TURNOVER_RATE

  Turnover rate

• PE_RATIO

  P/E ratio

• CHANGE_RATE

  Yield

KLFields

enum KLFields
{
    KLFields_None = 0; //
    KLFields_High = 1; //High
    KLFields_Open = 2; //Open
    KLFields_Low = 4; //Low
    KLFields_Close = 8; //Close
    KLFields_LastClose = 16; //Close of the previous K-line
    KLFields_Volume = 32; //Volume
    KLFields_Turnover = 64; //Turnover
    KLFields_TurnoverRate = 128; //Turnover rate
    KLFields_PE = 256; //P/E ratio
    KLFields_ChangeRate = 512; //Yield
}

Candlestick Type

• Python
• Proto

KLType

• NONE

  unknown

• K_1M

  1 minute candlestick

• K_3M

  3 minutes candlestick

  Option is not supported

• K_5M

  5 minutes candlestick

• K_15M

  15 minutes candlestick

• K_30M

  30 minutes candlestick

  Option is not supported

• K_60M

  60 minutes candlestick

• K_10M

  10 minutes candlestick

  Option is not supported

• K_120M

  120 minutes candlestick (2 hours)

  Option is not supported

• K_180M

  180 minutes candlestick (3 hours)

  Option is not supported

• K_240M

  240 minutes candlestick (4 hours)

  Option is not supported

• K_DAY

  1 day candlestick

• K_WEEK

  1 week candlestick

  Option is not supported

• K_MON

  1 month candlestick

  Option is not supported

• K_QUARTER

  1 quarter candlestick

  Option is not supported

• K_YEAR

  1 year candlestick

  Option is not supported

KLType

enum KLType
{
    KLType_Unknown = 0; //Unknown
    KLType_1Min = 1; //1 minute candlestick
    KLType_Day = 2; //1 day candlestick
    KLType_Week = 3; //1 week candlestick (Option is not supported)
    KLType_Month = 4; //1 month candlestick (Option is not supported)
    KLType_Year = 5; //1 year candlestick (Option is not supported)
    KLType_5Min = 6; //5 minutes candlestick
    KLType_15Min = 7; //15 minutes candlestick
    KLType_30Min = 8; //30 minutes candlestick (Option is not supported)
    KLType_60Min = 9; //60 minutes candlestick
    KLType_3Min = 10; //3 minutes candlestick (Option is not supported)
    KLType_Quarter = 11; //1 quarter candlestick (Option is not supported)
    KLType_10Min = 12; //10 minutes candlestick (Option is not supported)
    KLType_120Min = 13; //120 minutes candlestick (2 hours) (Option is not supported)
    KLType_180Min = 14; //180 minutes candlestick (3 hours) (Option is not supported)
    KLType_240Min = 15; //240 minutes candlestick (4 hours) (Option is not supported)
}

Period Type

• Python
• Proto

PeriodType

• INTRADAY

  Intraday

• DAY

  Day

• WEEK

  Week

• MONTH

  Month

PeriodType

enum PeriodType
{
    PeriodType_INTRADAY = 0; //Intraday
    PeriodType_DAY = 1; //DAY
    PeriodType_WEEK = 2; //Week
    PeriodType_MONTH = 3; //Month
}

Price Reminder Market Status

• Python
• Proto

PriceReminderMarketStatus

• UNKNOW

  unknown

• OPEN

  Market opens

• US_PRE

  Pre-market of US stocks

• US_AFTER

  After-hours of US stocks

• US_OVERNIGHT

  Overnight trading session of US stocks

MarketStatus

enum MarketStatus
{
    MarketStatus_Unknow = 0;
    MarketStatus_Open = 1; //Market opens
    MarketStatus_USPre = 2; //Pre-market
    MarketStatus_USAfter = 3; //After-hours
}

Watchlist Operation

• Python
• Proto

ModifyUserSecurityOp

• NONE

  Unknown

• ADD

  Add

• DEL

  Delete

• MOVE_OUT

  Remove from group

ModifyUserSecurityOp

enum ModifyUserSecurityOp
{
    ModifyUserSecurityOp_Unknown = 0; //Unknown
    ModifyUserSecurityOp_Add = 1; //Add
    ModifyUserSecurityOp_Del = 2; //Delete
    ModifyUserSecurityOp_MoveOut = 3; //Remove from group
}

Option Type (by Exercise Time)

• Python
• Proto

OptionAreaType

• NONE

  unknown

• AMERICAN

  American Option

• EUROPEAN

  European Option

• BERMUDA

  Bermuda Option

OptionAreaType

enum OptionAreaType
{
    OptionAreaType_Unknown = 0; //Unknown
    OptionAreaType_American = 1; //American Option
    OptionAreaType_European = 2; //European Option
    OptionAreaType_Bermuda = 3; //Bermuda Option
}

Option in/out of The Money

• Python
• Proto

OptionCondType

• ALL

  All

• WITHIN

  In the money

• OUTSIDE

  Out of the money

OptionCondType

enum OptionCondType
{
    OptionCondType_Unknow = 0; //All
    OptionCondType_WithIn = 1; //In the money
    OptionCondType_Outside = 2; //Out of the money
}

Option Type (by Direction)

• Python
• Proto

OptionType

• ALL

  all

• CALL

  Call option

• PUT

  Put option

OptionType

enum OptionType
{
    OptionType_Unknown = 0; //Unknown
    OptionType_Call = 1; //Call option
    OptionType_Put = 2; //Put option
};

Option Strategy Type

• Python
• Proto

OptionStrategyType

• NONE

  Unknown

• SINGLE

  Single option

• COVERED

  Covered

• SPREAD

  Vertical spread

• STRADDLE

  Straddle

• STRANGLE

  Strangle

• COLLAR

  Collar

• BUTTERFLY

  Butterfly

• CONDOR

  Condor

• IRON_BUTTERFLY

  Iron butterfly

• IRON_CONDOR

  Iron condor

• CALENDAR_SPREAD

  Calendar spread

• DIAGONAL_SPREAD

  Diagonal spread

• CUSTOM

  Custom

OptionStrategyType

enum OptionStrategyType
{
    OptionStrategyType_Unknown = 0; //Unknown
    OptionStrategyType_Single = 1; //Single option
    OptionStrategyType_Covered = 2; //Covered
    OptionStrategyType_Spread = 3; //Vertical spread
    OptionStrategyType_Straddle = 4; //Straddle
    OptionStrategyType_Strangle = 5; //Strangle
    OptionStrategyType_Collar = 6; //Collar
    OptionStrategyType_Butterfly = 7; //Butterfly
    OptionStrategyType_Condor = 8; //Condor
    OptionStrategyType_IronButterfly = 9; //Iron butterfly
    OptionStrategyType_IronCondor = 10; //Iron condor
    OptionStrategyType_CalendarSpread = 11; //Calendar spread
    OptionStrategyType_DiagonalSpread = 12; //Diagonal spread
    OptionStrategyType_Custom = 13; //Custom
};

News Sub Type

• Python
• Proto

NewsSubType

• ALL

  All

• NEWS

  News

• NOTICE

  Notice

• RATING

  Rating

NewsSubType

enum NewsSubType
{
    NewsSubType_ALL = 0; //All
    NewsSubType_NEWS = 1; //News
    NewsSubType_NOTICE = 2; //Notice
    NewsSubType_RATING = 3; //Rating
};

Plate Set Type

• Python
• Proto

Plate

• ALL

  All plates

• INDUSTRY

  Industry plate

• REGION

  Regional plate

  The regional plate of the Hong Kong and US stock markets are temporarily empty.

• CONCEPT

  Concept plate

• OTHER

  Other plates

  Only used for the return of the Get plates of stocks interface and cannot be used as a request parameter of other interfaces.

PlateSetType

enum PlateSetType
{
    PlateSetType_All = 0; //All plate
    PlateSetType_Industry = 1; //Industry plate
    PlateSetType_Region = 2; //Regional plate (the regional plate of the Hong Kong and US stock markets are temporarily empty)
    PlateSetType_Concept = 3; //Concept plate
    PlateSetType_Other = 4; //Other plates, only used for 3207 (acquiring the plate to which the stock belongs) protocol return, and cannot be used as a request parameter of other protocols
}

Price Reminder Frequency

• Python
• Proto

PriceReminderFreq

• NONE

  Unknown

• ALWAYS

  Keep reminding

• ONCE_A_DAY

  Once a day

• ONCE

  Only remind once

PriceReminderFreq

enum PriceReminderFreq
{
    PriceReminderFreq_Unknown = 0; //Unknown
    PriceReminderFreq_Always = 1; //Keep reminding
    PriceReminderFreq_OnceADay = 2; //Once a day
    PriceReminderFreq_OnlyOnce = 3; //Only remind once
}

Price Reminder Type

• Python
• Proto

PriceReminderType

• NONE

  Unknown

• PRICE_UP

  Price rise to

• PRICE_DOWN

  Price fall to

• CHANGE_RATE_UP

  Daily increase rate exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

• CHANGE_RATE_DOWN

  Daily decline rate exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

• FIVE_MIN_CHANGE_RATE_UP

  Increate rate in 5 minutes exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

• FIVE_MIN_CHANGE_RATE_DOWN

  Decline rate in 5 minutes exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

• VOLUME_UP

  Volume exceeds

• TURNOVER_UP

  Turnover exceeds

• TURNOVER_RATE_UP

  Turnover rate exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

• BID_PRICE_UP

  Bid price higher than

• ASK_PRICE_DOWN

  Ask price lower than

• BID_VOL_UP

  Bid volume higher than

• ASK_VOL_UP

  Ask volume higher than

• THREE_MIN_CHANGE_RATE_UP

  Increate rate in 3 minutes exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

• THREE_MIN_CHANGE_RATE_DOWN

  Decline rate in 3 minutes exceeds

  This field is in percentage form, so 20 is equivalent to 20%.

PriceReminderType

enum PriceReminderType
{
    PriceReminderType_Unknown = 0; //Unknown
    PriceReminderType_PriceUp = 1; //Price rise to
    PriceReminderType_PriceDown = 2; //Price fall to
    PriceReminderType_ChangeRateUp = 3; //Daily increase rate exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
    PriceReminderType_ChangeRateDown = 4; //Daily decline rate exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
    PriceReminderType_5MinChangeRateUp = 5; //Increate rate in 5 minutes exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
    PriceReminderType_5MinChangeRateDown = 6; //Decline rate in 5 minutes exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
    PriceReminderType_VolumeUp = 7; //Volume exceeds
    PriceReminderType_TurnoverUp = 8; //Turnover exceeds
    PriceReminderType_TurnoverRateUp = 9; //Turnover rate exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
    PriceReminderType_BidPriceUp = 10; //Bid price higher than
    PriceReminderType_AskPriceDown = 11; //Ask price lower than
    PriceReminderType_BidVolUp = 12; //Bid volume higher than
    PriceReminderType_AskVolUp = 13; //Ask volume higher than
    PriceReminderType_3MinChangeRateUp = 14; //Increate rate in 3 minutes exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
    PriceReminderType_3MinChangeRateDown = 15; //Decline rate in 3 minutes exceeds (This field is in percentage form, so 20 is equivalent to 20%.)
}

Warrant in/out of the Money

• Python
• Proto

PriceType

• UNKNOW

  Unknown

• OUTSIDE

  Out of the money

• WITH_IN

  In the money

PriceType

enum PriceType
{
    PriceType_Unknow = 0; //Unknown
    PriceType_Outside = 1; //Out of the money
    PriceType_WithIn = 2; //In the money
}

Quote Push Type

• Python
• Proto

PushDataType

• UNKNOW

  Unknown

• REALTIME

  Real-time data

• BYDISCONN

  Pull supplementary data (up to 50) during disconnection from Futu server

• CACHE

  Non-real-time non-supplementary data

PushDataType

enum PushDataType
{
    PushDataType_Unknow = 0; //Unknown
    PushDataType_Real-time = 1; //Real-time data
    PushDataType_ByDisConn = 2; //Pull supplementary data during the disconnection of the background market (up to 50)
    PushDataType_Cache = 3; //Non-real-time non-supplementary data
}

Quote Market

• Python
• Proto

Market

• NONE

  Unknown market

• HK

  HK market

• US

  US market

• SH

  Shanghai market

• SZ

  Shenzhen market

• SG

  Singapore market

• JP

  Japanese market

• AU

  Australian market

• MY

  Malaysian market

• CA

  Canadian market

• FX

  Forex market

• CC

  Cryptocurrency market

QotMarket

enum QotMarket
{
    QotMarket_Unknown = 0; //Unknown market
    QotMarket_HK_Security = 1; //HK market
    QotMarket_HK_Future = 2; //Hong Kong futures market (deprecated, just use QotMarket_HK_Security)
    QotMarket_US_Security = 11; //US market
    QotMarket_CNSH_Security = 21; //Shanghai market
    QotMarket_CNSZ_Security = 22; //Shenzhen market
    QotMarket_SG_Security = 31; //Singapore market
    QotMarket_JP_Security = 41; //Japanese market
    QotMarket_AU_Security = 51; //Australian market
    QotMarket_MY_Security = 61; //Malaysian market
    QotMarket_CA_Security = 71; //Canadian market
    QotMarket_FX_Security = 81; //Forex market
    QotMarket_CC_Security = 91; //Cryptocurrency market

}

Market State

• Python
• Proto

MarketState

Corresponding time period of each market state, click here to learn more

• NONE

  No trading

• AUCTION

  Pre-market trading

• WAITING_OPEN

  Waiting for opening

• MORNING

  Morning session

• REST

  Lunch break

• AFTERNOON

  Afternoon session / Regular trading hours for U.S stock market

• CLOSED

  Market closed

• PRE_MARKET_BEGIN

  Pre-market trading of U.S stock market

• PRE_MARKET_END

  Pre-market ending of U.S stock market

• AFTER_HOURS_BEGIN

  After-hours trading of U.S stock market

• AFTER_HOURS_END

  Market closed of U.S. stock market

• OVERNIGHT

  Overnight trading of U.S. stock market

• NIGHT_OPEN

  Night market trading hours

• NIGHT_END

  Night market closed

• NIGHT

  Night market trading hours for U.S. index options

• TRADE_AT_LAST

  Late trading hours for U.S. index options

• FUTURE_DAY_OPEN

  Day market trading hours

• FUTURE_DAY_BREAK

  Day market break

• FUTURE_DAY_CLOSE

  Day market closed

• FUTURE_DAY_WAIT_OPEN

  Futures market wait for opening

• HK_CAS

  After-hours bidding for HK stocks

• FUTURE_NIGHT_WAIT

  Futures night market wait for opening (Obsolete)

• FUTURE_AFTERNOON

  Futures afternoon (Obsolete)

• FUTURE_SWITCH_DATE

  Waiting for U.S. futures opening

• FUTURE_OPEN

  Trading hours of U.S. futures

• FUTURE_BREAK

  Break of U.S. futures

• FUTURE_BREAK_OVER

  Trading hours of U.S. futures after break

• FUTURE_CLOSE

  Market closed of U.S. futures

• STIB_AFTER_HOURS_WAIT

  After-hours matching period on the Sci-tech innovation plate (Obsolete)

• STIB_AFTER_HOURS_BEGIN

  After-hours trading on the Sci-tech innovation plate begins (Obsolete)

• STIB_AFTER_HOURS_END

  After-hours trading on the Sci-tech innovation plate ends (Obsolete)

QotMarketState

Corresponding time period of each market state, click here to learn more

enum QotMarketState
{
    QotMarketState_None = 0; //No trading
    QotMarketState_Auction = 1; //Pre-market trading
    QotMarketState_WaitingOpen = 2; //Waiting for opening
    QotMarketState_Morning = 3; //Morning session
    QotMarketState_Rest = 4; //Lunch break
    QotMarketState_Afternoon = 5; //Afternoon session / Regular trading hours for U.S stock market
    QotMarketState_Closed = 6; //Market closed
    QotMarketState_PreMarketBegin = 8; //Pre-market trading of U.S stock market
    QotMarketState_PreMarketEnd = 9; //Pre-market ending of U.S stock market
    QotMarketState_AfterHoursBegin = 10; //After-hours trading of U.S stock market
    QotMarketState_AfterHoursEnd = 11; //Market closed of U.S. stock market
    QotMarketState_NightOpen = 13; //Night market trading hours
    QotMarketState_NightEnd = 14; //Night market closed
    QotMarketState_FutureDayOpen = 15; //Day market trading hours
    QotMarketState_FutureDayBreak = 16; //Day market break
    QotMarketState_FutureDayClose = 17; //Day market closed
    QotMarketState_FutureDayWaitForOpen = 18; //Futures market wait for opening
    QotMarketState_HkCas = 19; //After-hours bidding
    QotMarketState_FutureNightWait = 20; //Futures night market wait for opening (Obsolete)
    QotMarketState_FutureAfternoon = 21; //Futures afternoon (Obsolete)
    //New status of US futures
    QotMarketState_FutureSwitchDate = 22; //Waiting for U.S. futures opening
    QotMarketState_FutureOpen = 23; //Trading hours of U.S. futures
    QotMarketState_FutureBreak = 24; //Break of U.S. futures
    QotMarketState_FutureBreakOver = 25; //Trading hours of U.S. futures after break
    QotMarketState_FutureClose = 26; //Market closed of U.S. futures
    //New status of Sci-tech Innovation Board
    QotMarketState_StibAfterHoursWait = 27; //After-hours matching period on the Sci-tech innovation plate(Obsolete)
    QotMarketState_StibAfterHoursBegin = 28; //After-hours trading on the Sci-tech innovation plate begins(Obsolete)
    QotMarketState_StibAfterHoursEnd = 29; //After-hours trading on the Sci-tech innovation plate ends(Obsolete)
    //New status for US index options
    QotMarketState_NIGHT = 32; //Night trading hours of U.S. index options
    QotMarketState_TRADE_AT_LAST = 35; //Late trading hours of U.S. index options
    QotMarketState_OVERNIGHT = 37;  //Overnight trading hours for U.S stock market
}

US Stock Session

• Python
• Proto

Session

• NONE

  Unknown

• RTH

  US Stocks Regular trading hours

• ETH

  US Stocks Pre/Post + regular trading hours

• OVERNIGHT

  US Stocks Overnight trading hours (only applied to Trade API)

• ALL

  US Stocks 24H trading hours (applied to Quote API & Trade API)

Session

enum Session
{
	Session_NONE = 0; // Unknown
	Session_RTH = 1; // Regular Trading Hours
	Session_ETH = 2; // RTH + Pre/Post-Mkt
	Session_ALL = 3; // 24 Hour Trading
	Session_OVERNIGHT = 4; // Overnight Trading
}

Quote Authorities

• Python
• Proto

QotRight

• UNKNOW

  Unknown

• BMP

  BMP (subscription is not supported for this permission)

• LEVEL1

  Level1

• LEVEL2

  Level2

• SF

  HK Securities FullTick Quotes

• NO

  No permission

QotRight

enum QotRight
{
    QotRight_Unknow = 0; //Unknown
    QotRight_Bmp = 1; //BMP (subscription is not supported for this permission)
    QotRight_Level1 = 2; //Level1
    QotRight_Level2 = 3; //Level2
    QotRight_SF = 4; //SF advanced market
    QotRight_No = 5; //No permission
}

Associated * Data Type

• Python
• Proto

SecurityReferenceType

• UNKNOW

  Unknown

• WARRANT

  Warrants for stocks

• FUTURE

  Contracts related to futures main

ReferenceType

enum ReferenceType
{
    ReferenceType_Unknow = 0; //Unknown
    ReferenceType_Warrant = 1; //Warrants for stocks
    ReferenceType_Future = 2; //Contracts related to futures main
}

Candlestick Adjustment Type

• Python
• Proto

AuType

• NONE

  Actual

• QFQ

  Adjust forward

• HFQ

  Adjust backward

RehabType

enum RehabType
{
    RehabType_None = 0; //Actual
    RehabType_Forward = 1; //Adjust forward
    RehabType_Backward = 2; //Adjust backward
}

Stock Status

• Python
• Proto

SecurityStatus

• NONE

  Unknown

• NORMAL

  Normal status

• LISTING

  To be listed

• PURCHASING

  Purchasing

• SUBSCRIBING

  Subscribing

• BEFORE_DRAK_TRADE_OPENING

  Before the grey market trading opens

• DRAK_TRADING

  Ongoing grey market trading

• DRAK_TRADE_END

  Grey market trading closed

• TO_BE_OPEN

  To be open

• SUSPENDED

  Suspended

• CALLED

  Called

• EXPIRED_LAST_TRADING_DATE

  Expired latest trading date

• EXPIRED

  Expired

• DELISTED

  Delisted

• CHANGE_TO_TEMPORARY_CODE

  During the company action, the trading was closed and transferred to the temporary code trading

• TEMPORARY_CODE_TRADE_END

  Temporary trading ends

• CHANGED_PLATE_TRADE_END

  Plate changed, the old code is not available for trading

• CHANGED_CODE_TRADE_END

  The code has been changed, the old code is not available for trading

• RECOVERABLE_CIRCUIT_BREAKER

  Recoverable circuit breaker

• UN_RECOVERABLE_CIRCUIT_BREAKER

  Unrecoverable circuit breaker

• AFTER_COMBINATION

  After-hours matchmaking

• AFTER_TRANSATION

  After-hours trading

SecurityStatus

enum SecurityStatus
{
    SecurityStatus_Unknown = 0; //Unknown
    SecurityStatus_Normal = 1; //Normal status
    SecurityStatus_Listing = 2; //To be listed
    SecurityStatus_Purchasing = 3; //Purchasing
    SecurityStatus_Subscribing = 4; //Subscribing
    SecurityStatus_BeforeDrakTradeOpening = 5; //Before the grey market trading opens
    SecurityStatus_DrakTrading = 6; //Ongoing grey market trading
    SecurityStatus_DrakTradeEnd = 7; //Grey market trading closed
    SecurityStatus_ToBeOpen = 8; //To be open
    SecurityStatus_Suspended = 9; //Suspended
    SecurityStatus_Called = 10; //Called
    SecurityStatus_ExpiredLastTradingDate = 11; //Expired latest trading date
    SecurityStatus_Expired = 12; //Expired
    SecurityStatus_Delisted = 13; //Delisted
    SecurityStatus_ChangeToTemporaryCode = 14; //During the company action, the trading was closed and transferred to the temporary code trading
    SecurityStatus_TemporaryCodeTradeEnd = 15; //Temporary trading ends
    SecurityStatus_ChangedPlateTradeEnd = 16; //Plate changed, the old trading code is not available
    SecurityStatus_ChangedCodeTradeEnd = 17; //The code has been changed, the old code is not available
    SecurityStatus_RecoverableCircuitBreaker = 18; //Recoverable circuit breaker
    SecurityStatus_UnRecoverableCircuitBreaker = 19; //Unrecoverable circuit breaker
    SecurityStatus_AfterCombination = 20; //After-hours matchmaking
    SecurityStatus_AfterTransation = 21; //After-hours trading
}

Stock Type

• Python
• Proto

SecurityType

• NONE

  Unknown

• BOND

  Bonds

• BWRT

  Blanket warrants

• STOCK

  Stocks

• ETF

  ETFs

• WARRANT

  Warrants

• IDX

  Indexs

• PLATE

  Plates

• DRVT

  Options

• PLATESET

  Plate sets

• FUTURE

  Futures

• CRYPTO

  Cryptocurrency

SecurityType

enum SecurityType
{
    SecurityType_Unknown = 0; //Unknown
    SecurityType_Bond = 1; //Bonds
    SecurityType_Bwrt = 2; //Blanket warrants
    SecurityType_Eqty = 3; //Stocks
    SecurityType_Trust = 4; //ETFs
    SecurityType_Warrant = 5; //Warrants
    SecurityType_Index = 6; //Indexs
    SecurityType_Plate = 7; //Plates
    SecurityType_Drvt = 8; //Options
    SecurityType_PlateSet = 9; //Plate Sets
    SecurityType_Future = 10; //Futures
    SecurityType_Crypto = 12; //Cryptocurrency
}

Set Price Reminder Operation Type

• Python
• Proto

SetPriceReminderOp

• NONE

  Unknown

• ADD

  Add

• DEL

  Delete

• ENABLE

  Enable

• DISABLE

  Disable

• MODIFY

  Modify

• DEL_ALL

  Delete all (delete all price alerts under the specified stock)

SetPriceReminderOp

enum SetPriceReminderOp
{
    SetPriceReminderOp_Unknown = 0;
    SetPriceReminderOp_Add = 1; //Add
    SetPriceReminderOp_Del = 2; //Delete
    SetPriceReminderOp_Enable = 3; //Enable
    SetPriceReminderOp_Disable = 4; //Disable
    SetPriceReminderOp_Modify = 5; //Modify
    SetPriceReminderOp_DelAll = 6; //Delete all (delete all price reminders under the specified stock)
}

Sort Direction

• Python
• Proto

SortDir

• NONE

  Not sorted

• ASCEND

  Ascending

• DESCEND

  Descending

SortDir

enum SortDir
{
    SortDir_No = 0; //Do not sort
    SortDir_Ascend = 1; //Ascending order
    SortDir_Descend = 2; //Descending order
}

Sort Field

• Python
• Proto

SortField

• NONE

  Unknown

• CODE

  Code

• CUR_PRICE

  Latest price

• PRICE_CHANGE_VAL

  Price changed

• CHANGE_RATE

  Yield

• STATUS

  Status

• BID_PRICE

  Bid price

• ASK_PRICE

  Ask price

• BID_VOL

  Bid volume

• ASK_VOL

  Ask volume

• VOLUME

  Volume

• TURNOVER

  Turnover

• AMPLITUDE

  Amplitude

• SCORE

  Comprehensive score

• PREMIUM

  Premium

• EFFECTIVE_LEVERAGE

  Effective leverage

• DELTA

  Hedging value

  For puts and calls only

• IMPLIED_VOLATILITY

  Implied volatility

  For puts and calls only

• TYPE

  Type

• STRIKE_PRICE

  Strike price

• BREAK_EVEN_POINT

  Break even point

• MATURITY_TIME

  Maturity date

• LIST_TIME

  Listing date

• LAST_TRADE_TIME

  Lastest trading day

• LEVERAGE

  Leverage ratio

• IN_OUT_MONEY

  In/out of the money %

• RECOVERY_PRICE

  Recovery price

  For CBBCs only

• CHANGE_PRICE

  Change price

• CHANGE

  Change ratio

• STREET_RATE

  Outstanding percentage (the propotioin of retail investors)

• STREET_VOL

  Outstanding quantity (the volume held by retail investors)

• WARRANT_NAME

  Warrant name

• ISSUER

  Issuer

• LOT_SIZE

  Lot size

• ISSUE_SIZE

  Issue size

• UPPER_STRIKE_PRICE

  Upper bound

  Only for Inline Warrants

• LOWER_STRIKE_PRICE

  Lower bound

  Only for Inline Warrants

• INLINE_PRICE_STATUS

  In/out of bounds

  Only for Inline Warrants

• PRE_CUR_PRICE

  Latest price of pre-market

• AFTER_CUR_PRICE

  Latest price of after-hours

• PRE_PRICE_CHANGE_VAL

  Pre-market changes

• AFTER_PRICE_CHANGE_VAL

  After-hours changes

• PRE_CHANGE_RATE

  Pre-market change rate %

• AFTER_CHANGE_RATE

  After-hours change rate %

• PRE_AMPLITUDE

  Pre-market amplitude %

• AFTER_AMPLITUDE

  After-hours amplitude %

• PRE_TURNOVER

  Pre-market turnover

• AFTER_TURNOVER

  After-hours turnover

• LAST_SETTLE_PRICE

  Last settle price

• POSITION

  Position

• POSITION_CHANGE

  Daily increase of position

• MARKET_CAP

  Market cap, for use with Qot_GetValuationPlateStockList

• VALUATION

  Valuation, for use with Qot_GetValuationPlateStockList

• FORWARD_VALUATION

  Forward valuation, for use with Qot_GetValuationPlateStockList

• HISTORICAL_PERCENTILE

  Historical percentile, for use with Qot_GetValuationPlateStockList

• HOLDER_QUANTITY

  Number of shares held, for use with shareholder protocols

• SHARE_CHANGE_NUM

  Change in shares held, for use with shareholder protocols

• HOLDING_DATE

  Holding date, for use with shareholder protocols

• HOLDER_PCT_CHANGE

  Change ratio in holdings, for use with shareholder protocols

• HOLDER_CHANGE_AMOUNT

  Change amount in holdings, for use with shareholder protocols

• HOLDER_PCT

  Holding percentage, for use with shareholder protocols

SortField

enum SortField
{
    SortField_Unknow = 0; //Unknown
    SortField_Code = 1; //Code
    SortField_CurPrice = 2; //Latest price
    SortField_PriceChangeVal = 3; //Price changed
    SortField_ChangeRate = 4; //Yield
    SortField_Status = 5; //Status
    SortField_BidPrice = 6; //Bid price
    SortField_AskPrice = 7; //Ask price
    SortField_BidVol = 8; //Bid volume
    SortField_AskVol = 9; //Ask volume
    SortField_Volume = 10; //Volume
    SortField_Turnover = 11; //Turnover
    SortField_Amplitude = 30; //Amplitude

    //The following sort fields are only supported for Qot_GetWarrant protocol
    SortField_Score = 12; //Comprehensive score
    SortField_Premium = 13; //Premium
    SortField_EffectiveLeverage = 14; //Effective leverage
    SortField_Delta = 15; //Hedging value, for puts and calls only
    SortField_ImpliedVolatility = 16; //Implied volatility, for puts and calls only
    SortField_Type = 17; //Type
    SortField_StrikePrice = 18; //Strike price
    SortField_BreakEvenPoint = 19; //Break even point
    SortField_MaturityTime = 20; //Maturity date
    SortField_ListTime = 21; //Listing date
    SortField_LastTradeTime = 22; //Lastest trading day
    SortField_Leverage = 23; //Leverage ratio
    SortField_InOutMoney = 24; //In/out of the money %
    SortField_RecoveryPrice = 25; //Recovery price, for CBBCs only
    SortField_ChangePrice = 26; //Change price
    SortField_Change = 27; //Change ratio
    SortField_StreetRate = 28; //Outstanding percentage (the propotioin of retail investors)
    SortField_StreetVol = 29; //Outstanding quantity (the volume held by retail investors)
    SortField_WarrantName = 31; //Warrant name
    SortField_Issuer = 32; //Issuer
    SortField_LotSize = 33; //Lot size
    SortField_IssueSize = 34; //Issue size
    SortField_UpperStrikePrice = 45; //Upper bound, only for Inline Warrants
    SortField_LowerStrikePrice = 46; //Lower bound, only for Inline Warrants
    SortField_InLinePriceStatus = 47; //In/out of bounds, only for Inline Warrants

    //The following sort fields are only supported for the Qot_GetPlateSecurity protocol, and only support US stocks
    SortField_PreCurPrice = 35; //Latest price of pre-market
    SortField_AfterCurPrice = 36; //Latest price of after-hours
    SortField_PrePriceChangeVal = 37; //Pre-market changes
    SortField_AfterPriceChangeVal = 38; //After-hours changes
    SortField_PreChangeRate = 39; //Pre-market change rate %
    SortField_AfterChangeRate = 40; //After-hours change rate %
    SortField_PreAmplitude = 41; //Pre-market amplitude %
    SortField_AfterAmplitude = 42; //After-hours amplitude %
    SortField_PreTurnover = 43; //Pre-market turnover
    SortField_AfterTurnover = 44; //After-hours turnover

    //The following sort fields are only supported for the Qot_GetPlateSecurity protocol, and only futures
    SortField_LastSettlePrice = 48; //Last settle price 
    SortField_Position = 49; //Position
    SortField_PositionChange = 50; //Daily increase of position

    //The following sort fields are only supported for the Qot_GetValuationPlateStockList protocol
    SortField_MarketCap = 51; //Market cap
    SortField_Valuation = 52; //Valuation
    SortField_ForwardValuation = 53; //Forward valuation
    SortField_HistoricalPercentile = 54; //Historical percentile

    //The following sort fields are only supported for shareholder protocols
    SortField_HolderQuantity = 61; //Number of shares held
    SortField_ShareChangeNum = 62; //Change in shares held
    SortField_HoldingDate = 63; //Holding date
    SortField_HolderPctChange = 64; //Change ratio in holdings
    SortField_HolderChangeAmount = 65; //Change amount in holdings
    SortField_HolderPct = 66; //Holding percentage
}

Sort Order

• Python
• Proto

SortType

• NONE

  Unknown

• DESC

  Descending

• ASC

  Ascending

SortType

enum SortType
{
    SortType_Unknown = 0; // Unknown
    SortType_Desc    = 1; // Descending
    SortType_Asc     = 2; // Ascending
}

Financial Report Type

• Python
• Proto

F10Type

• NONE

  Unknown

• Q1

  Single quarter report, Q1

• Q2

  Single quarter report, Q2

• Q3

  Single quarter report, Q3

• Q4

  Single quarter report, Q4

• Q6

  Cumulative quarter report, Q6 (Q1+Q2)

• Q9

  Cumulative quarter report, Q9 (Q1+Q2+Q3)

• ANNUAL

  Annual report

• QUARTERLY

  Single quarter combination (Q1, Q2, Q3, Q4)

• QUARTERLY_ANNUAL

  Single quarter + annual report

• MUL_QUARTERLY

  Cumulative quarter reports (Q1, Q6, Q9, Annual)

F10Type

enum F10Type
{
    F10Type_Unknown         = 0;
    F10Type_Q1              = 1;   // Single quarter report, Q1
    F10Type_Q2              = 2;   // Single quarter report, Q2
    F10Type_Q3              = 3;   // Single quarter report, Q3
    F10Type_Q4              = 4;   // Single quarter report, Q4
    F10Type_Q6              = 5;   // Cumulative quarter report, Q6 (Q1+Q2)
    F10Type_Q9              = 6;   // Cumulative quarter report, Q9 (Q1+Q2+Q3)
    F10Type_Annual          = 7;   // Annual report
    F10Type_Quarterly       = 9;   // Single quarter combination (Q1, Q2, Q3, Q4)
    F10Type_QuarterlyAnnual = 10;  // Single quarter + annual report
    F10Type_MulQuarterly    = 11;  // Cumulative quarter reports (Q1, Q6, Q9, Annual)
}

Earnings Publication Time Type

• Python
• Proto

EarningsPubTimeType

• NONE

  Unknown

• PRE_MARKET

  Pre-market

• AFTER_MARKET

  After-market

• DURING_MARKET

  During market hours

EarningsPubTimeType

enum EarningsPubTimeType
{
    EarningsPubTimeType_Unknown      = 0; // Unknown
    EarningsPubTimeType_PreMarket    = 1; // Pre-market
    EarningsPubTimeType_AfterMarket  = 2; // After-market
    EarningsPubTimeType_DuringMarket = 3; // During market hours
}

Valuation Type

• Python
• Proto

ValuationType

• NONE

  Unknown

• PE

  P/E ratio

• PB

  P/B ratio

• PS

  P/S ratio

ValuationType

enum ValuationType
{
    ValuationType_Unknown = 0; // Unknown
    ValuationType_PE      = 1; // P/E ratio
    ValuationType_PB      = 2; // P/B ratio
    ValuationType_PS      = 3; // P/S ratio
}

Financial Statements Type

• Python
• Proto

FinancialStatementsType

• NONE

  Unknown

• INCOME

  Income statement

• BALANCE_SHEET

  Balance sheet

• CASH_FLOW

  Cash flow statement

• MAIN_INDEX

  Key metrics

FinancialStatementsType

enum FinancialStatementsType
{
    FinancialStatementsType_Unknown      = 0;
    FinancialStatementsType_Income       = 1; // Income statement
    FinancialStatementsType_BalanceSheet = 2; // Balance sheet
    FinancialStatementsType_CashFlow     = 3; // Cash flow statement
    FinancialStatementsType_MainIndex    = 4; // Key metrics
}

Revenue Breakdown Dimension Type

• Python
• Proto

RevenueBreakdownType

• NONE

  Unknown

• PRODUCT

  Product

• INDUSTRY

  Industry

• REGION

  Region

• BUSINESS

  Business

RevenueBreakdownType

enum RevenueBreakdownType
{
    RevenueBreakdownType_Unknown  = 0;
    RevenueBreakdownType_Product  = 1; // Product
    RevenueBreakdownType_Industry = 2; // Industry
    RevenueBreakdownType_Region   = 4; // Region
    RevenueBreakdownType_Business = 8; // Business
}

Analyst Rating

• Python
• Proto

ResearchRatingType

• NONE

  Unknown

• SELL

  Sell

• UNDERPERFORM

  Underperform

• HOLD

  Hold

• BUY

  Buy

• STRONG_BUY

  Strong Buy

ResearchRatingType

enum ResearchRatingType
{
    ResearchRatingType_Unknown      = 0; // Unknown
    ResearchRatingType_Sell         = 1; // Sell
    ResearchRatingType_Underperform = 2; // Underperform
    ResearchRatingType_Hold         = 3; // Hold
    ResearchRatingType_Buy          = 4; // Buy
    ResearchRatingType_StrongBuy    = 5; // Strong Buy
}

Research Rating Dimension Type

• Python
• Proto

ResearchRatingDimensionType

• NONE

  Unknown

• INSTITUTION

  Institution dimension (default)

• ANALYST

  Analyst dimension

ResearchRatingDimensionType

enum ResearchRatingDimensionType
{
    ResearchRatingDimensionType_Unknown     = 0;
    ResearchRatingDimensionType_Institution = 1; // Institution dimension (default)
    ResearchRatingDimensionType_Analyst     = 2; // Analyst dimension
}

Morningstar Rating Type

• Python
• Proto

MorningstarRatingType

• NONE

  Unknown

• QUANTITATIVE

  Quantitative rating (system model)

• QUALITATIVE

  Qualitative rating (analyst-assigned)

MorningstarRatingType

enum MorningstarRatingType
{
    MorningstarRatingType_Unknown      = 0; // Unknown
    MorningstarRatingType_Quantitative = 1; // Quantitative rating (system model)
    MorningstarRatingType_Qualitative  = 2; // Qualitative rating (analyst-assigned)
}

Valuation Historical Interval Type

• Python
• Proto

ValuationIntervalType

• NONE

  Unknown

• MONTH3

  3 months

• MONTH6

  6 months

• YEAR1

  1 year

• YEAR2

  2 years

• YEAR3

  3 years

• YEAR5

  5 years

• YEAR10

  10 years

• YEAR20

  20 years

• YEAR30

  30 years

• SINCE2019

  Since 2019

ValuationIntervalType

enum ValuationIntervalType
{
    ValuationIntervalType_Unknown   = 0;  // Unknown
    ValuationIntervalType_Month3    = 1;  // 3 months
    ValuationIntervalType_Month6    = 2;  // 6 months
    ValuationIntervalType_Year1     = 3;  // 1 year
    ValuationIntervalType_Year3     = 4;  // 3 years
    ValuationIntervalType_Since2019 = 5;  // Since 2019
    ValuationIntervalType_Year5     = 6;  // 5 years
    ValuationIntervalType_Year10    = 7;  // 10 years
    ValuationIntervalType_Year2     = 8;  // 2 years
    ValuationIntervalType_Year20    = 9;  // 20 years
    ValuationIntervalType_Year30    = 10; // 30 years
}

Corporate Action Reform Type

• Python
• Proto

ReformType

• NONE

  Unknown

• STOCK_SPLIT

  Stock split

• STOCK_MERGE

  Stock merge

• BONUS_SHARE

  Bonus share

• CAPITALIZATION_OF_RESERVES

  Capitalization of reserves

• RIGHTS_ISSUE

  Rights issue

• NEW_SHARE_ISSUANCE

  New share issuance

• CASH_DIVIDEND

  Cash dividend

• SPECIAL_DIVIDEND

  Special dividend

• SPINOFF

  Spinoff

ReformType

enum ReformType
{
    ReformType_Unknown                  = 0;   // Unknown
    ReformType_StockSplit               = 1;   // Stock split
    ReformType_StockMerge               = 2;   // Stock merge
    ReformType_BonusShare               = 4;   // Bonus share
    ReformType_CapitalizationOfReserves = 8;   // Capitalization of reserves
    ReformType_RightsIssue              = 16;  // Rights issue
    ReformType_NewShareIssuance         = 32;  // New share issuance
    ReformType_CashDividend             = 64;  // Cash dividend
    ReformType_SpecialDividend          = 128; // Special dividend
    ReformType_Spinoff                  = 256; // Spinoff
}

Holding Changes Filter Type

• Python
• Proto

HoldingChangesFilterType

• NONE

  All (default)

• INCREASE

  Increase

• DECREASE

  Decrease

• NEW_IN

  New position

• CLOSE_OUT

  Close out

HoldingChangesFilterType

enum HoldingChangesFilterType
{
    HoldingChangesFilterType_Unknown  = 0; // All (default)
    HoldingChangesFilterType_Increase = 1; // Increase
    HoldingChangesFilterType_Decrease = 2; // Decrease
    HoldingChangesFilterType_NewIn    = 3; // New position
    HoldingChangesFilterType_CloseOut = 4; // Close out
}

Holder Detail Institution Type

• Python
• Proto

HolderDetailType

• DEFAULT

  Default, no filter — server-side default logic applies

• ALL

  All

• UNCLASSIFIED

  Other institutions

• TRADITIONAL_INVESTMENT_MANAGER

  Traditional investment manager

• HEDGE_FUND_MANAGER

  Hedge fund

• VC_OR_PE

  Venture capital / private equity

• CORPORATE_PENSION_PLAN_SPONSOR

  Corporate pension plan

• FOUNDATION_FUND_SPONSOR

  Foundation fund

• INSURANCE_COMPANY

  Insurance company

• BANK_OR_INVESTMENT_BANK

  Bank / investment bank

• FAMILY_OFFICES_OR_TRUST

  Family office / trust

• SOVEREIGN_WEALTH_FUND

  Sovereign wealth fund

• REIT

  REIT

• STRUCTURED_FINANCE_POOL_MANAGER

  Structured finance pool manager

• UNION_PENSION_PLAN_SPONSOR

  Union pension plan

• GOVERNMENT_PENSION_PLAN_SPONSOR

  Government pension plan

• ENDOWMENT_FUND_SPONSOR

  Endowment fund

• INDIVIDUAL_INSIDERS

  Individual

• ISSUE_SPONSORED_ADR

  ADS

• CORPORATIONS_PUBLIC

  Public corporation

• CORPORATIONS_PRIVATE

  Private corporation

• STATE_OWNED_SHARES

  State-owned shares

HolderDetailType

enum HolderDetailType
{
    HolderDetailType_Default                      = 0;    // Default, no filter — server-side default logic applies
    HolderDetailType_All                          = 1000; // All
    HolderDetailType_Unclassified                 = 1;    // Other institutions
    HolderDetailType_TraditionalInvestmentManager = 2;    // Traditional investment manager
    HolderDetailType_HedgeFundManager             = 3;    // Hedge fund
    HolderDetailType_VCOrPE                       = 4;    // Venture capital / private equity
    HolderDetailType_CorporatePensionPlanSponsor  = 5;    // Corporate pension plan
    HolderDetailType_FoundationFundSponsor        = 6;    // Foundation fund
    HolderDetailType_InsuranceCompany             = 7;    // Insurance company
    HolderDetailType_BankOrInvestmentBank         = 8;    // Bank / investment bank
    HolderDetailType_FamilyOfficesOrTrust         = 9;    // Family office / trust
    HolderDetailType_SovereignWealthFund          = 10;   // Sovereign wealth fund
    HolderDetailType_REIT                         = 11;   // REIT
    HolderDetailType_StructuredFinancePoolManager = 12;   // Structured finance pool manager
    HolderDetailType_UnionPensionPlanSponsor      = 13;   // Union pension plan
    HolderDetailType_GovernmentPensionPlanSponsor = 14;   // Government pension plan
    HolderDetailType_EndowmentFundSponsor         = 15;   // Endowment fund
    HolderDetailType_IndividualInsiders           = 100;  // Individual
    HolderDetailType_IssueSponsoredADR            = 200;  // ADS
    HolderDetailType_CorporationsPublic           = 300;  // Public corporation
    HolderDetailType_CorporationsPrivate          = 400;  // Private corporation
    HolderDetailType_StateOwnedShares             = 500;  // State-owned shares
}

Company Profile Field Type

• Python
• Proto

CompanyProfileFieldType

• SOURCE_TEXT

  Text

• LINK_TYPE

  Link

• INDEPENDENT_TITLE

  Independent title

CompanyProfileFieldType

enum CompanyProfileFieldType
{
    CompanyProfileFieldType_SourceText       = 0; // Text
    CompanyProfileFieldType_LinkType         = 1; // Link
    CompanyProfileFieldType_IndependentTitle = 2; // Independent title
}

Broker Net Buy/Sell Direction

• Python
• Proto

BuySellType

• NONE

  Unknown

• NET_BUY

  Net buy

• NET_SELL

  Net sell

BuySellType

enum BuySellType
{
    BuySellType_Unknown = 0;
    BuySellType_NetBuy  = 1; // Net buy
    BuySellType_NetSell = 2; // Net sell
}

Option Volatility Query Time Period Type

• Python
• Proto

OptionVolatilityTimePeriodType

• NONE

  Unknown

• WEEK

  Week

• MONTH

  Month (default)

• QUARTER

  Quarter

• HALF_YEAR

  Half year

• YEAR

  Year

OptionVolatilityTimePeriodType

enum OptionVolatilityTimePeriodType
{
    OptionVolatilityTimePeriodType_Unknown  = 0; // Unknown
    OptionVolatilityTimePeriodType_Week     = 1; // Week
    OptionVolatilityTimePeriodType_Month    = 2; // Month (default)
    OptionVolatilityTimePeriodType_Quarter  = 3; // Quarter
    OptionVolatilityTimePeriodType_HalfYear = 4; // Half year
    OptionVolatilityTimePeriodType_Year     = 5; // Year
}

Option Implied Volatility Status Type

• Python
• Proto

OptionImpvolStatusType

• IMPVOL_FLUCTUATING

  Option implied volatility is fluctuating

• IMPVOL_OVERVALUED

  Option implied volatility is overvalued

• IMPVOL_UNDERVALUED

  Option implied volatility is undervalued

OptionImpvolStatusType

enum OptionImpvolStatusType
{
    ImpvolFluctuating = 0; // Option implied volatility is fluctuating
    ImpvolOvervalued  = 1; // Option implied volatility is overvalued
    ImpvolUndervalued = 2; // Option implied volatility is undervalued
}

Simple Filter Properties

• Python
• Proto

StockField

• NONE

  unknown

• STOCK_CODE

  Stock code, does not accept list inputs as an interval

• STOCK_NAME

  Stock name, does not accept list inputs as an interval

• CUR_PRICE

  The latest price

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [10, 20]

• CUR_PRICE_TO_HIGHEST52_WEEKS_RATIO

  (CP - WH52) / WH52
  CP: Current price
  WH52: 52-week high
  Corresponding to the “percentage from 52-week high” on the PC terminal

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-30, -10]

• CUR_PRICE_TO_LOWEST52_WEEKS_RATIO

  (CP - WL52) / WL52
  CP: Current price
  WL52: 52-week low
  Corresponding to the “percentage from 52-week low” on the PC terminal

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [20, 40]

• HIGH_PRICE_TO_HIGHEST52_WEEKS_RATIO

  (TH - WH52) / WH52
  TH: Today's high
  WH52: 52-week high
  

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-3, -1]

• LOW_PRICE_TO_LOWEST52_WEEKS_RATIO

  (TL - WL52) / WL52
  TL: Today's low
  WL52: 52-week low
  

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [10, 70]

• VOLUME_RATIO

  Volume ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [0.5, 30]

• BID_ASK_RATIO

  Bid-ask ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-20, 80.5]

• LOT_PRICE

  Price per lot

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [40, 100]

• MARKET_VAL

  Market value

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [50000000, 3000000000]

• PE_ANNUAL

  Trailing P/E

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [-8, 65.3]

• PE_TTM

  P/E TTM

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [-10, 20.5]

• PB_RATE

  P/B ratio

  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [0.5, 20]

• CHANGE_RATE_5MIN

  Change rate in 5 minutes

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-5, 6.3]

• CHANGE_RATE_BEGIN_YEAR

  Price change rate from this year

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [-50.1, 400.7]

• PS_TTM

  P/S TTM

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [100, 500]

• PCF_TTM

  PCF TTM

  • 3 decimal place accuracy, the excess part is discarded.
  • This field is in percentage form, so 20 is equivalent to 20%.
  • For example, a range of [100, 1000]

• TOTAL_SHARE

  Total number of shares

  • unit: share.
  • 0 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• FLOAT_SHARE

  Shares outstanding

  • unit: share.
  • 0 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

• FLOAT_MARKET_VAL

  Market value outstanding

  • unit: yuan.
  • 3 decimal place accuracy, the excess part is discarded.
  • For example, a range of [1000000000, 1000000000]

StockField

enum StockField
{
    StockField_Unknown = 0; //Unknown
    StockField_StockCode = 1; //Stock code, does not accept list inputs as an interval
    StockField_StockName = 2; //Stock name, does not accept list inputs as an interval
    StockField_CurPrice = 3; //The latest price(3 decimal place accuracy, the excess part is discarded), for example, a range of [10, 20]
    StockField_CurPriceToHighest52WeeksRatio = 4; //(Current price - 52-week high) / 52-week high, corresponding to the “percentage from 52-week high” on the PC terminal(3 decimal place accuracy, the excess part is discarded), for example, a range of [-30, -10] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_CurPriceToLowest52WeeksRatio = 5; //(Current price - 52-week minimum) / 52-week minimum, corresponding to the “percentage from 52-week low” on the PC terminal(3 decimal place accuracy, the excess part is discarded), for example, a range of [20, 40] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_HighPriceToHighest52WeeksRatio = 6; //(Today's high - 52 weeks' highest) / 52 weeks' highest(3 decimal place accuracy, the excess part is discarded), for example, a range of [-3, -1] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_LowPriceToLowest52WeeksRatio = 7; //(Today's low-52 weeks' lowest) / 52 weeks' lowest(3 decimal place accuracy, the excess part is discarded), for example, a range of [10, 70] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_VolumeRatio = 8; //Volume ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [0.5, 30]
    StockField_BidAskRatio = 9; //Bid-ask ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [-20, 80.5] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_LotPrice = 10; //Price per lot(3 decimal place accuracy, the excess part is discarded), for example, a range of [40, 100]
    StockField_MarketVal = 11; //Market value(3 decimal place accuracy, the excess part is discarded), for example, a range of [50000000, 3000000000]
    StockField_PeAnnual = 12; //Trailing P/E(3 decimal place accuracy, the excess part is discarded), for example, a range of [-8, 65.3]
    StockField_PeTTM = 13; //P/E TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [-10, 20.5]
    StockField_PbRate = 14; //P/B ratio(3 decimal place accuracy, the excess part is discarded), for example, a range of [0.5, 20]
    StockField_ChangeRate5min = 15; //Change rate in 5 minutes(3 decimal place accuracy, the excess part is discarded), for example, a range of [-5, 6.3] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_ChangeRateBeginYear = 16; //Price change rate from this year(3 decimal place accuracy, the excess part is discarded), for example, a range of [-50.1, 400.7] (This field is in percentage form, so 20 is equivalent to 20%.)
        
    // Basic volume and price attributes
    StockField_PSTTM = 17; //P/S TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [100, 500] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_PCFTTM = 18; //PCF TTM(3 decimal place accuracy, the excess part is discarded), for example, a range of [100, 1000] (This field is in percentage form, so 20 is equivalent to 20%.)
    StockField_TotalShare = 19; //Total number of shares(0 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: share)
    StockField_FloatShare = 20; //Shares outstanding(0 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: share)
    StockField_FloatMarketVal = 21; //Market value outstanding(3 decimal place accuracy, the excess part is discarded), for example, a range of [1000000000, 1000000000] (unit: yuan)
}

Subscription Type

• Python
• Proto

SubType

• NONE

  Unknown

• QUOTE

  Basic quote

• ORDER_BOOK

  Order book

• TICKER

  Tick-by-tick

• RT_DATA

  Time Frame

• K_DAY

  Daily candlesticks

• K_5M

  5 minutes candlesticks

• K_15M

  15 minutes candlesticks

• K_30M

  30 minutes candlesticks

• K_60M

  60 minutes candlesticks

• K_1M

  1 minute candlesticks

• K_WEEK

  Weekly candlesticks

• K_MON

  Monthly candlesticks

• BROKER

  Broker's queue

• K_QURATER

  Seasonal candlesticks

• K_YEAR

  Annual candlesticks

• K_3M

  3 minutes candlesticks

• K_10M

  10 minutes candlesticks

• K_120M

  120 minutes candlesticks (2 hours)

• K_180M

  180 minutes candlesticks (3 hours)

• K_240M

  240 minutes candlesticks (4 hours)

• ORDER_BOOK_ODD

  Odd lot order book

SubType

enum SubType
{
    SubType_None = 0; //Unknown
    SubType_Basic = 1; //Basic quote
    SubType_OrderBook = 2; //Order book
    SubType_Ticker = 4; //Tick-by-tick
    SubType_RT = 5; //Time Frame
    SubType_KL_Day = 6; //Daily candlesticks
    SubType_KL_5Min = 7; //5 minutes candlesticks
    SubType_KL_15Min = 8; //15 minutes candlesticks
    SubType_KL_30Min = 9; //30 minutes candlesticks
    SubType_KL_60Min = 10; //60 minutes candlesticks
    SubType_KL_1Min = 11; //1 minute candlesticks
    SubType_KL_Week = 12; //Weekly candlesticks
    SubType_KL_Month = 13; //Monthly candlesticks
    SubType_Broker = 14; //Broker's queue
    SubType_KL_Qurater = 15; //Seasonal candlesticks
    SubType_KL_Year = 16; //Annual candlesticks
    SubType_KL_3Min = 17; //3 minutes candlesticks
    SubType_KL_10Min = 18; //10 minutes candlesticks
    SubType_KL_120Min = 19; //120 minutes candlesticks (2 hours)
    SubType_KL_180Min = 20; //180 minutes candlesticks (3 hours)
    SubType_KL_240Min = 21; //240 minutes candlesticks (4 hours)
    SubType_OrderBook_Odd = 22; //Odd Lot Order Book
}

Order Book Type

• Python
• Proto

OrderBookType

• NORMAL

  Normal order book (default)

• ODD

  Odd lot order book

OrderBookType

enum OrderBookType
{
    OrderBookType_Normal = 0; //Normal order book (default)
    OrderBookType_Odd = 1; //Odd lot order book
}

Transaction Direction

• Python
• Proto

TickerDirect

• NONE

  unknown

• BUY

  Active buy

  Active buy, a buyer actively buys stocks at the then sell price or higher price.

• SELL

  Active sell

  Active sell, a seller actively sells stocks at the then buy price or lower price.

• NEUTRAL

  Neutral transaction

  Neutral transaction, the stock price is between the bid price and ask price.

TickerDirection

enum TickerDirection
{
    TickerDirection_Unknown = 0; //Unknown
    TickerDirection_Bid = 1; //Active buy, a buyer actively buys stocks at the then sell price or higher price.
    TickerDirection_Ask = 2; //Active sell, a seller actively sells stocks at the then buy price or lower price.
    TickerDirection_Neutral = 3; //Neutral transaction, the stock price is between the bid price and ask price.
}

Tick-by-Tick Transaction Type

• Python
• Proto

TickerType

• UNKNOWN

  Unknown

• AUTO_MATCH

  Regular sale

• LATE

  Pre-market trade

• NON_AUTO_MATCH

  Non-regular sale

• INTER_AUTO_MATCH

  Regular sale for same broker

• INTER_NON_AUTO_MATCH

  Non-regular sale for same broker

• ODD_LOT

  Odd lot trade

• AUCTION

  Auction trade

• BULK

  Bunched trade

• CRASH

  Cash trade

• CROSS_MARKET

  Intermarket sweep

• BULK_SOLD

  Bunched sold trade

• FREE_ON_BOARD

  Price variation trade

• RULE127_OR155

  Rule 127 (NYSE only) or Rule 155 (NYSE MKT only)

• DELAY

  Delay the transaction

• MARKET_CENTER_CLOSE_PRICE

  Market center close price

• NEXT_DAY

  Next day

• MARKET_CENTER_OPENING

  Market center opening trade

• PRIOR_REFERENCE_PRICE

  Prior reference price

• MARKET_CENTER_OPEN_PRICE

  Market center open price

• SELLER

  Seller

• T

  Form T(pre-open and post-close market trade)

• EXTENDED_TRADING_HOURS

  Extended trading hours/sold out of sequence

• CONTINGENT

  Contingent trade

• AVERAGE_PRICE

  Average price trade

• OTC_SOLD

  Sold(out of sequence)

• ODD_LOT_CROSS_MARKET

  Odd lot cross trade

• DERIVATIVELY_PRICED

  Derivatively priced

• REOPENINGP_RICED

  Re-Opening price

• CLOSING_PRICED

  Closing price

• COMPREHENSIVE_DELAY_PRICE

  Consolidated late price per listing packet

• OVERSEAS

  One party to the transaction is not a member of the Hong Kong Stock Exchange and is an over-the-counter transaction

TickerType

enum TickerType
{
    TickerType_Unknown = 0; //Unknown
    TickerType_Automatch = 1; //Regular sale
    TickerType_Late = 2; //Pre-market trade
    TickerType_NoneAutomatch = 3; //Non-regular sale
    TickerType_InterAutomatch = 4; //Regular sale for same broker
    TickerType_InterNoneAutomatch = 5; //Non-regular sale for same broker
    TickerType_OddLot = 6; //Odd lot trade
    TickerType_Auction = 7; //Auction trade
    TickerType_Bulk = 8; //Bunched Trade
    TickerType_Crash = 9; //Cash Trade
    TickerType_CrossMarket = 10; //Intermarket sweep
    TickerType_BulkSold = 11; //Bunched sold trade
    TickerType_FreeOnBoard = 12; //Price variation trade
    TickerType_Rule127Or155 = 13; //Rule 127 (NYSE only) or Rule 155 (NYSE MKT only)
    TickerType_Delay = 14; //Sold last
    TickerType_MarketCenterClosePrice = 15; //Market center close price
    TickerType_NextDay = 16; //Next day
    TickerType_MarketCenterOpening = 17; //Market center opening trade
    TickerType_PriorReferencePrice = 18; //Prior reference price
    TickerType_MarketCenterOpenPrice = 19; //Market center open price
    TickerType_Seller = 20; //Seller
    TickerType_T = 21; //Form T(pre-open and post-close market trade)
    TickerType_ExtendedTradingHours = 22; //Extended trading hours/sold out of sequence
    TickerType_Contingent = 23; //Contingent trade
    TickerType_AvgPrice = 24; //Average price trade
    TickerType_OTCSold = 25; //Sold(out of sequence)
    TickerType_OddLotCrossMarket = 26; //Odd lot cross trade
    TickerType_DerivativelyPriced = 27; //Derivatively priced
    TickerType_ReOpeningPriced = 28; //Re-Opening price
    TickerType_ClosingPriced = 29; //Closing price
    TickerType_ComprehensiveDelayPrice = 30; //Consolidated late price per listing packet
    TickerType_Overseas = 31; //One party to the transaction is not a member of the Hong Kong Stock Exchange and is an over-the-counter transaction
}

Check The Market on The Trading Day

• Python
• Proto

TradeDateMarket

• NONE

  Unknown

• HK

  HK market

  • Including stocks, ETFs, warrants, CBBCs, options, non-holiday trading futures
  • Excluding holiday trading futures

• US

  US market

  • Including stocks, ETFs, options
  • Excluding futures

• CN

  A-share market

• NT

  Northbound Trading

• ST

  Southbound Trading

• JP_FUTURE

  Japanese future market

• SG_FUTURE

  Singapore future market

TradeDateMarket

enum TradeDateMarket
{
    TradeDateMarket_Unknown = 0; //Unknown
    TradeDateMarket_HK = 1; //HK market (including stocks, ETFs, warrants, CBBCs, options, futures)
    TradeDateMarket_US = 2; //US market (including stocks, ETFs, options. Excluding futures)
    TradeDateMarket_CN = 3; //A-share stock market
    TradeDateMarket_NT = 4; //HK->SZ (SH) Connect
    TradeDateMarket_ST = 5; //Southbound (SZ, SH)
    TradeDateMarket_JP_Future = 6; //Japanese future market
    TradeDateMarket_SG_Future = 7; //Singapore future market
    TradeDateMarket_SG = 8; //Singapore securities
    TradeDateMarket_MY = 9; //Malaysia
    TradeDateMarket_JP = 10; //Japan (Stocks/ETFs)
}

Type of Trading Day

• Python
• Proto

TradeDateType

• WHOLE

  Whole day trading

• MORNING

  Trading in the morning, closed in the afternoon

• AFTERNOON

  Trading in the afternoon, closed in the morning

TradeDateType

enum TradeDateType
{
    TradeDateType_Whole = 0; //Whole day trading
    TradeDateType_Morning = 1; //Trading in the morning, closed in the afternoon
    TradeDateType_Afternoon = 2; //Trading in the afternoon, closed in the morning
}

Warrant Status

• Python
• Proto

WarrantStatus

• NONE

  Unknown

• NORMAL

  Normal status

• SUSPEND

  Suspended

• STOP_TRADE

  Stop trading

• PENDING_LISTING

  Waiting to be listed

WarrantStatus

enum WarrantStatus
{
    WarrantStatus_Unknow = 0; //Unknown
    WarrantStatus_Normal = 1; //Normal status
    WarrantStatus_Suspend = 2; //Suspended
    WarrantStatus_StopTrade = 3; //Stop trading
    WarrantStatus_PendingListing = 4; //Waiting to be listed
}

Warrant Type

• Python
• Proto

WrtType

• NONE

  Unknown

• CALL

  Long warrants

• PUT

  Short warrants

• BULL

  Call warrants

• BEAR

  Put warrants

• INLINE

  Inline Warrants

WarrantType

enum WarrantType
{
    WarrantType_Unknown = 0; //Unknown
    WarrantType_Buy = 1; //Long warrants
    WarrantType_Sell = 2; //Short warrants
    WarrantType_Bull = 3; //Call warrants
    WarrantType_Bear = 4; //Put warrants
    WarrantType_InLine = 5; //Inline Warrants
}

Exchange Type

• Python
• Proto

ExchType

• NONE

  Unknown

• HK_MAINBOARD

  HKEx·Main Board

• HK_GEMBOARD

  HKEx·GEM

• HK_HKEX

  HKEx

• US_NYSE

  NYSE

• US_NASDAQ

  NASDAQ

• US_PINK

  OTC Mkt

• US_AMEX

  AMEX

• US_OPTION

  US

  Only applicable to US Options.

• US_NYMEX

  NYMEX

• US_COMEX

  COMEX

• US_CBOT

  CBOT

• US_CME

  CME

• US_CBOE

  CBOE

• CN_SH

  SH Stock Ex

• CN_SZ

  SZ Stock Ex

• CN_STIB

  STAR

• SG_SGX

  SGX

• JP_OSE

  OSE

• CC_CRYPTO

  Cryptocurrency Exchange

ExchType

enum ExchType
{
    ExchType_Unknown = 0; //Unknown
    ExchType_HK_MainBoard = 1; // HKEx·Main Board
    ExchType_HK_GEMBoard = 2; //HKEx·GEM
    ExchType_HK_HKEX = 3; //HKEx
    ExchType_US_NYSE = 4; //NYSE
    ExchType_US_Nasdaq = 5; //NASDAQ
    ExchType_US_Pink = 6; //OTC Mkt
    ExchType_US_AMEX = 7; //AMEX 
    ExchType_US_Option = 8; //US (Only applicable to US Options.)
    ExchType_US_NYMEX = 9; //NYMEX 
    ExchType_US_COMEX = 10; //COMEX
    ExchType_US_CBOT = 11; //CBOT
    ExchType_US_CME = 12; //CME
    ExchType_US_CBOE = 13; //CBOE
    ExchType_CN_SH = 14; //SH Stock Ex
    ExchType_CN_SZ = 15; //SZ Stock Ex
    ExchType_CN_STIB = 16; //STAR
    ExchType_SG_SGX = 17; //SGX
    ExchType_JP_OSE = 18; //OSE
    ExchType_CC_CRYPTO = 19; //Cryptocurrency Exchange
    ExchType_MY_MYX = 20; //Malaysia Exchange
    ExchType_JP_TSE = 21; //Tokyo Stock Exchange
    ExchType_JP_Nikkei = 22; //Nikkei Index
};

Quote Common Parameter Header

QotHeader

message QotHeader
{
    optional int32 securityFirm = 1; //Security firm identifier, see Trd_Common.SecurityFirm
}

Security Identification

Security

message Security
{
    required int32 market = 1; //QotMarket, quote market
    required string code = 2; //Code
}

Candlestick data

KLine

message KLine
{
    required string time = 1; //String of timestamp (Format: yyyy-MM-dd HH:mm:ss)
    required bool isBlank = 2; //Whether it is a point with empty content, if it is true, only time information
    optional double highPrice = 3; //High
    optional double openPrice = 4; //Open
    optional double lowPrice = 5; //Low
    optional double closePrice = 6; //Close
    optional double lastClosePrice = 7; //Close of the previous K-line
    optional int64 volume = 8; //Volume
    optional double turnover = 9; //Turnover
    optional double turnoverRate = 10; // Turnover rate (this field is in decimal form, so 0.2 is equivalent to 20%)
    optional double pe = 11; //P/E ratio
    optional double changeRate = 12; //Yield (This field is in percentage form, so 20 is equivalent to 20%.)
    optional double timestamp = 13; //Timestamp
}

Option Specific Fields of The Underlying Quote

OptionBasicQotExData

message OptionBasicQotExData
{
    required double strikePrice = 1; //Strike price
    required int32 contractSize = 2; //Contract size (integer)
    optional double contractSizeFloat = 17; //Contract size (float)
    required int32 openInterest = 3; //Number of open positions
    required double impliedVolatility = 4; //Implied volatility (This field is in percentage form, so 20 is equivalent to 20%.)
    required double premium = 5; //Premium (This field is in percentage form, so 20 is equivalent to 20%.)
    required double delta = 6; //Greek value Delta
    required double gamma = 7; //Greek value Gamma
    required double vega = 8; //Greek value Vega
    required double theta = 9; //Greek value Theta
    required double rho = 10; //Greek value Rho
    optional int32 netOpenInterest = 11; //Net open contract number , only HK options support this field
    optional int32 expiryDateDistance = 12; //The number of days from the expiry date, a negative number means it has expired.
    optional double contractNominalValue = 13; //Contract nominal amount , only HK options support this field
    optional double ownerLotMultiplier = 14; //Equal number of underlying stocks, index options do not have this field , only HK options support this field  
    optional int32 optionAreaType = 15; //OptionAreaType, option type (by exercise time).
    optional double contractMultiplier = 16; //Contract multiplier
    optional int32 indexOptionType = 18; //Qot_Common.IndexOptionType, index option type
}    

Futures Specific Fields of The Base Quote

FutureBasicQotExData

message FutureBasicQotExData
{
    required double lastSettlePrice = 1; //Close yesterday
    required int32 position = 2; //Hold position
    required int32 positionChange = 3; //Daily change in position
    optional int32 expiryDateDistance = 4; //The number of days from the expiration date
}    

Basic Quotation

BasicQot

message BasicQot
{
    required Security security = 1; //Stock
    optional string name = 24; // stock name
    required bool isSuspended = 2; //whether trading is suspended
    required string listTime = 3; //listed date string (This field is deprecated. Format: yyyy-MM-dd)
    required double priceSpread = 4; //Spread
    required string updateTime = 5; //Update time string of the latest price (Format: yyyy-MM-dd HH:mm:ss), not applicable to other fields
    required double highPrice = 6; //High
    required double openPrice = 7; //Open
    required double lowPrice = 8; //low
    required double curPrice = 9; //The latest price
    required double lastClosePrice = 10; //Close yesterday
    required int64 volume = 11; //Volume
    required double turnover = 12; //Turnover
    required double turnoverRate = 13; //Turnover rate (This field is in percentage form, so 20 is equivalent to 20%.)
    required double amplitude = 14; //Amplitude (This field is in percentage form, so 20 is equivalent to 20%.)
    optional int32 darkStatus = 15; //Grey market trading status
    optional OptionBasicQotExData optionExData = 16; //Option specific field
    optional double listTimestamp = 17; //Time stamp of listing date (This field is deprecated.)
    optional double updateTimestamp = 18; //Update timestamp of the latest price, not applicable to other fields
    optional PreAfterMarketData preMarket = 19; //Pre-market data
    optional PreAfterMarketData afterMarket = 20; //After-hours data
    optional int32 secStatus = 21; //Security status
    optional FutureBasicQotExData futureExData = 22; //Futures specific field
}

Before And After Data

PreAfterMarketData

//US stocks support pre-market and after-hours data
//The Sci-tech Innovation Plate only supports after-hours data: trading volume, turnover
message PreAfterMarketData
{
    optional double price = 1; //Pre-market or after-hours## Price
    optional double highPrice = 2; //Pre-market or after-hours## High
    optional double lowPrice = 3; //Pre-market or after-hours## Low
    optional int64 volume = 4; //Pre-market or after-hours## Volume
    optional double turnover = 5; //Pre-market or after-hours## Turnover
    optional double changeVal = 6; //Pre-market or after-hours## Change in price
    optional double changeRate = 7; //Pre-market or after-hours## Yield (This field is in percentage form, so 20 is equivalent to 20%.)
    optional double amplitude = 8; //Pre-market or after-hours## Amplitude (This field is in percentage form, so 20 is equivalent to 20%.)
}

Time Frame Data

TimeShare

message TimeShare
{
    required string time = 1; //Time string (Format: yyyy-MM-dd HH:mm:ss)
    required int32 minute = 2; //Minutes after 0 o'clock
    required bool isBlank = 3; //Whether the content is empty, if true, it contents only time
    optional double price = 4; //Current price
    optional double lastClosePrice = 5; //Close yesterday
    optional double avgPrice = 6; //Average price
    optional int64 volume = 7; //Volume
    optional double turnover = 8; //Turnover
    optional double timestamp = 9; //Timestamp
}

Basic Static Information of Securities

SecurityStaticBasic

message SecurityStaticBasic
{
    required Qot_Common.Security security = 1; //Stock
    required int64 id = 2; //Stock ID
    required int32 lotSize = 3; //Lot size, the option type represents the number of shares in a contract
    required int32 secType = 4; //Qot_Common.SecurityType, stock type
    required string name = 5; //Stock name
    required string listTime = 6; //Listing time string (This field is deprecated. Format: yyyy-MM-dd)
    optional bool delisting = 7; //Delisted or not
    optional double listTimestamp = 8; //Listing timestamp (This field is deprecated.)
    optional int32 exchType = 9; //Qot_Common.ExchType, Exchange Type
}

Warrant Additional Static Information

WarrantStaticExData

message WarrantStaticExData
{
    required int32 type = 1; //Qot_Common.WarrantType, Warrant Type
    required Qot_Common.Security owner = 2; //The underlying stock
}   

Option Additional Static Information

OptionStaticExData

message OptionStaticExData
{
    required int32 type = 1; //Qot_Common.OptionType, option
    required Qot_Common.Security owner = 2; //Underlying stock
    required string strikeTime = 3; //Exercise date (Format: yyyy-MM-dd)
    required double strikePrice = 4; //Strike price
    required bool suspend = 5; //Suspended or not
    required string market = 6; //Issuance market name
    optional double strikeTimestamp = 7; //Exercise date timestamp
    optional int32 indexOptionType = 8; //Qot_Common.IndexOptionType, type of index option, only valid for index option
    optional int32 expirationCycle = 9; // Qot_Common.ExpirationCycle, type of option expiration cycle
    optional int32 optionStandardType = 10; // Qot_Common.OptionStandardType, type of option standard
    optional int32 optionSettlementMode = 11; // OptionSettlementMode, mode of option settlement
}   

Additional Static Information About Futures

FutureStaticExData

message FutureStaticExData
{
    required string lastTradeTime = 1; //The lastest trading day, only future non-main contracts have this field
    optional double lastTradeTimestamp = 2; //The lastest trading day timestamp, only future non-main contracts have this field
    required bool isMainContract = 3; //Futures main contract or not
}    

Securities Static Information

SecurityStaticInfo

message SecurityStaticInfo
{
    required SecurityStaticBasic basic = 1; //Basic security information
    optional WarrantStaticExData warrantExData = 2; //Additional information for warrants
    optional OptionStaticExData optionExData = 3; //Additional information for options
    optional FutureStaticExData futureExData = 4; //Additional information for futures
}

Brokerage

Broker

message Broker
{
    required int64 id = 1; //Broker ID
    required string name = 2; //Broker name
    required int32 pos = 3; //Broker position
  
    //The following fields are specific to SF quote
    optional int64 orderID = 4; //Exchange order ID, which is different from the order ID returned by the trading interface
    optional int64 volume = 5; //Number of shares in order
}

Tick-by-Tick

Ticker

message Ticker
{
    required string time = 1; //Time string (Format: yyyy-MM-dd HH:mm:ss)
    required int64 sequence = 2; //Unique identification
    required int32 dir = 3; //TickerDirection, buy or sell direction
    required double price = 4; //Price
    required int64 volume = 5; //Volume
    required double turnover = 6; // turnover
    optional double recvTime = 7; //Local timestamp of received push data, used to locate delay
    optional int32 type = 8; //TickerType, type by pen
    optional int32 typeSign = 9; //Pattern-by-stroke type sign
    optional int32 pushDataType = 10; //Used to distinguish push situations, this field is only available when pushing
    optional double timestamp = 11; //time stamp}
}

Transaction File Details

OrderBookDetail

message OrderBookDetail
{
    required int64 orderID = 1; //Exchange order ID, which is different from the order ID returned by the trading interface
    required int64 volume = 2; //Number of shares in order
}

Order Book

OrderBook

message OrderBook
{
    required double price = 1; //Order price
    required int64 volume = 2; //Order quantity
    required int32 orederCount = 3; //Number of commissioned orders
    repeated OrderBookDetail detailList = 4; //Order information, unique to HK SF, US LV2 market
}

Changes in Holdings

ShareHoldingChange

message ShareHoldingChange
{
    required string holderName = 1; //Holder name (institution name or fund name or executive name)
    required double holdingQty = 2; //Current number of holdings
    required double holdingRatio = 3; //Current shareholding percentage (This field is in percentage form, so 20 is equivalent to 20%.)
    required double changeQty = 4; //The number of changes from the previous time
    required double changeRatio = 5; //The percentage of change from the last time (This field is in percentage form, so 20 is equivalent to 20%.. It is the ratio relative to itself, not to total. For example, if the total share capital is 10,000 shares, holding 100 shares, the shareholding percentage is 1%, if 50 shares are sold, the change ratio is 50% instead of 0.5%)
    required string time = 6; //Release time (Format: yyyy-MM-dd HH:mm:ss)
    optional double timestamp = 7; //Timestamp
}

Single Subscription Type Information

SubInfo

message SubInfo
{
    required int32 subType = 1; //Qot_Common.SubType, subscription type
    repeated Qot_Common.Security securityList = 2; //Subscribe to securities of this type of market
}

Single Connection Subscription Information

ConnSubInfo

message ConnSubInfo
{
    repeated SubInfo subInfoList = 1; //The connection subscription information
    required int32 usedQuota = 2; //The subscription quota that the connection has used
    required bool isOwnConnData = 3; //Used to distinguish whether it is self-connected data
    optional int32 securityFirm = 4; //Security firm identifier, see Trd_Common.SecurityFirm
}

Plate Information

PlateInfo

message PlateInfo
{
    required Qot_Common.Security plate = 1; //Plate
    required string name = 2; //Plate name
    optional int32 plateType = 3; //Plate type, only 3207 (to get the plate to which the stock belongs) agreement returns this field
}

Adjustment Information

Rehab

message Rehab
{
    required string time = 1; //Time string (Format: yyyy-MM-dd)
    required int64 companyActFlag = 2; //CompanyAct combination flag bit, which specifies whether certain field values ​​are valid
    required double fwdFactorA = 3; //Adjustments factor A
    required double fwdFactorB = 4; //Adjustments factor B
    required double bwdFactorA = 5; //Adjustments factor A
    required double bwdFactorB = 6; //Adjustments factor B
    optional int32 splitBase = 7; //Stock split (for example, 1 split 5, Base is 1, Ert is 5)
    optional int32 splitErt = 8;
    optional int32 joinBase = 9; //Reverse stock split (for example, 50 in 1, Base is 50, Ert is 1)
    optional int32 joinErt = 10;
    optional int32 bonusBase = 11; //Bonus shares (for example, 10 free 3, Base is 10, Ert is 3)
    optional int32 bonusErt = 12;
    optional int32 transferBase = 13; //Transfer bonus shares (for example, 10 to 3, Base is 10, Ert is 3)
    optional int32 transferErt = 14;
    optional int32 allotBase = 15; //Allotment (for example, 10 get 2 free, allotment price is 6.3 yuan, Base is 10, Ert is 2, and Price is 6.3)
    optional int32 allotErt = 16;
    optional double allotPrice = 17;
    optional int32 addBase = 18; //Additional shares (for example, 10 get 2 free, additional issuance price is 6.3 yuan, Base is 10, Ert is 2, and Price is 6.3)
    optional int32 addErt = 19;
    optional double addPrice = 20;
    optional double dividend = 21; //Cash dividend (for example, if every 10 shares are paid out 0.5 yuan, the field value is 0.05)
    optional double spDividend = 22; //Special dividend (for example, if a special dividend is 0.5 yuan for every 10 shares, the value of this field is 0.05)
    optional double timestamp = 23; //Timestamp
}

• For CompanyAct combination flag bit, refer to CompanyAct.

Combo Leg Information

ComboLeg

message ComboLeg
{
    required Qot_Common.Security security = 1; //Stock / option
    optional int32 side = 2; //Direction, refer to Trd_Common.TrdSide
    optional double qtyRatio = 3; //Quantity ratio
    optional uint64 positionID = 4; //Position ID. Fill in only when closing moomoo JP positions; must be the positionID from option strategy view positions when showOptionStrategyView=True.
}

Expiration Cycle

• Python
• Proto

ExpirationCycle

• NONE

  Unknown

• WEEK

  Weekly options

• MONTH

  Monthly options

• END_OF_MONTH

  End-Of-Monthly options

• QUARTERLY

  Quarterly options

• WEEKMON

  Monthly options-Monday

• WEEKTUE

  Monthly options-Tuesday

• WEEKWED

  Monthly options-Wednesday

• WEEKTHU

  Monthly options-Thursday

• WEEKFRI

  Monthly options-Friday

ExpirationCycle

enum ExpirationCycle
{
    ExperationCycle_Unknow = 0; //Unknown
    ExperationCycle_Week = 1; //Weekly options
    ExperationCycle_Month = 2; //Monthly options
    ExpirationCycle_MonthEnd = 3;  // End-Of-Monthly options
    ExpirationCycle_Quarter = 4; //Quarterly options
    ExpirationCycle_WeekMon = 11; //Monthly options-Monday
    ExpirationCycle_WeekTue = 12; //Monthly options-Tuesday
    ExpirationCycle_WeekWed = 13; //Monthly options-Wednesday
    ExpirationCycle_WeekThu = 14; //Monthly options-Thursday
    ExpirationCycle_WeekFri = 15; //Monthly options-Friday
}

Option Standard Type

• Python
• Proto

OptionStandardType

• NONE

  Unknown

• STANDARD

  standard options

• NON_STANDARD

  non-standard options

OptionStandardType

enum OptionStandardType
{
    OptionStandardType_Unknown = 0; //Unknown
    OptionStandardType_Standard = 1; // standard options
    OptionStandardType_NonStandard = 2; // non-standard options
}

Option Settlement Mode

• Python
• Proto

OptionSettlementMode

• NONE

  Unknown

• AM

  Asian Pricing

• PM

  Path-Dependent

OptionSettlementMode

enum OptionSettlementMode
{
    OptionSettlementMode_Unknown = 0; //Unknown
    OptionSettlementMode_AM = 1; // AM
    OptionSettlementMode_PM = 2; // PM
}

## Stockholder (Deprecated)

Stock Holder

• Python
• Proto

StockHolder

• NONE

  Unknown

• INSTITUTE

  Institute

• FUND

  Fund

• EXECUTIVE

  Executives

HolderCategory

enum HolderCategory
{
    HolderCategory_Unknow = 0; //Unknown
    HolderCategory_Agency = 1; //Institute
    HolderCategory_Fund = 2; //Fund
    HolderCategory_SeniorManager = 3; //Executives
}

Screening V2 - SimpleField

Used for the add_simple_field(field, values) method of get_stock_screen. All numeric fields accept raw values; OpenD performs magnification conversion automatically.

field	Meaning	values
1	MARKET	ScrMarket: HK=1, US=2, CN=3, SG=4, CA=5, AU=6, JA=7, MY=8
2	EXCHANGE / Listing venue	See QotMarket
3	INDEX_ID	Index constituent ID
4	USE_WATCHLIST	0=No, 1=Yes
5	HAS_ADR Whether the stock has a related ADR	0/1
6	HAS_OPTION Whether the stock has options	0/1
7	HAS_WARRANT Whether the stock has warrants	0/1
8	HAS_FUTURE Whether the stock has futures	0/1
9	HAS_AH_STOCK Whether the stock has an A/H counterpart	0/1
10	IS_ISLAMIC Islamic stock	0/1
11	NORTH_BOUND_ID Northbound plate	Shanghai/Shenzhen Connect ID
12	MM_EXCLUSIVE_ID Moomoo exclusive plate	Plate ID

For the full enum, see the SimpleField / ScrMarket classes in stock_screen_const.py of the SDK.

Screening V2 - SimpleProperty

Used by add_simple_property(name, lower, upper) and add_retrieve_simple(name). Common factors are listed below; all numeric values are raw.

name	Meaning
2101	LONG_MARGIN_ALLOWED Whether margin (long) is allowed (0/1)
2103	SHORT_MARGIN_ALLOWED Whether short selling is allowed (0/1)
2201	PRICE Last price
2202	OPEN_PRICE Open price
2203	LAST_CLOSE Previous close
2204	HIGH Today's high
2205	LOW Today's low
2217	VOLUME_RATIO Volume ratio
2218	BID_ASK_RATIO Bid-ask ratio
2301	MARKET_CAP Market cap
2302	PE_ANNUAL Static PE
2303	PE_TTM PE TTM
2304	PB Price/Book
2305	DIVIDEND_RATIO Dividend yield
2306	LISTED_DATE Listing date (timestamp)
2307	LISTED_DAYS Days since listing

See the SimpleProperty class for the full enum (including margin trading, pre/post-market, overnight session, high-precision quotes, etc., 60+ items in total).

Screening V2 - CumulativeProperty

Used by add_cumulative_property(name, days, lower, upper) and add_retrieve_cumulative(name, days). Requires the days argument.

name	Meaning
3101	PRICE_CHANGE Price change
3102	PRICE_CHANGE_PCT Price change ratio (%)
3103	AMPLITUDE Price amplitude (%)
3104	AVG_VOLUME Average volume
3105	AVG_TURNOVER Average turnover
3106	TURNOVER_RATIO Turnover ratio (%)
3107	HIGH_TO_N_DAY_HIGH (today's high - N-day high) / N-day high
3108	LOW_TO_N_DAY_LOW (today's low - N-day low) / N-day low
3109	PRICE_CHANGE_HP High-precision price change

Screening V2 - FinancialProperty

Used by add_financial_property(name, term, year, lower, upper) and add_retrieve_financial(name, term, year). Requires the term argument.

• Common factors (see the FinancialProperty class for the full enum, covering profitability / solvency / operating / growth / cash flow / financial surprise, 100+ items in total)

  name	Meaning
  4101	NET_PROFIT Net profit
  4102	NET_PROFIT_GROWTH Net profit growth rate
  4105	REVENUE Revenue
  4106	REVENUE_GROWTH Revenue growth rate
  4107	NET_PROFIT_RATIO Net profit margin
  4108	GROSS_PROFIT_RATIO Gross profit margin
  4109	DEBT_TO_ASSETS Debt-to-assets ratio
  4110	ROE Return on equity
  4202	ROIC Return on invested capital
  4801	BASIC_EPS Basic EPS
  4901	TOTAL_SHARE Total shares
  4903	FLOAT_MARKET_CAP Float market cap
  4904	PS_TTM Price-to-sales (TTM)
  4905	PCF_TTM Price-to-cash-flow (TTM)

• Term (Term enum)

  term	Meaning
  1 / 2 / 3 / 4	Q1 / Q2 / Q3 / Q4 single quarter
  6	Q6 interim report (cumulative)
  9	Q9 third-quarter report (cumulative)
  10	LATEST Latest single quarter
  100	ANNUAL Annual report (FY)
  200~204	SURPRISE_LATEST series (financial forecast)

Screening V2 - Indicator / Pattern / Period / Position

Used by add_indicator_positional / add_indicator_pattern / add_retrieve_indicator.

• Indicator technical indicators (first_indicator_name / second_indicator of add_indicator_positional)

  name	Meaning
  1	PRICE Last price
  11~17	MA5 / MA10 / MA20 / MA30 / MA60 / MA120 / MA250
  18	MA Dynamic simple moving average (requires indicator_params)
  21~27	EMA5 / EMA10 / EMA20 / EMA30 / EMA60 / EMA120 / EMA250
  28	EMA Dynamic exponential moving average
  31~33	KDJ_K / KDJ_D / KDJ_J (KDJ(9,3,3))
  41~43	MACD_DIF / MACD_DEA / MACD_MACD (MACD(12,26,9))
  51	RSI_12
  52	RSI Dynamic
  61~63	BOLL_UPPER / BOLL_MIDDLE / BOLL_LOWER (BOLL(20,2))
  71	RVOL Dynamic relative volume

• Pattern (name of add_indicator_pattern)

  name	Meaning
  1 / 2	MA bullish / bearish alignment
  3 / 4	EMA bullish / bearish alignment
  11 / 12	KDJ low-level golden cross / high-level death cross
  13 / 14	KDJ top divergence / bottom divergence
  21 / 22	MACD low-level golden cross / high-level death cross
  23 / 24	MACD top divergence / bottom divergence
  31 / 32	RSI low-level golden cross / high-level death cross
  33 / 34	RSI top divergence / bottom divergence

• Period

  period	Meaning
  1 / 2 / 3 / 4	1 / 3 / 5 / 15 minutes
  5	HOUR_1 1 hour
  6	MINUTE_30 30 minutes
  11 / 21 / 31	DAY / WEEK / MONTH

• Position

  position	Meaning
  1	OVER first is above second
  2	BELOW first is below second
  3	CROSS_UP first crosses above second
  4	CROSS_DOWN first crosses below second

• ScrSortDir sort direction (direction of set_sort / add_sort)

  direction	Meaning
  1	ASC ascending
  2	DESC descending
  3	ABS_ASC absolute-value ascending
  4	ABS_DESC absolute-value descending

Screening V2 - BasicProperty / Retrieve fields

Used by retrieve methods such as add_retrieve_basic(name). Other retrieve methods like add_retrieve_simple / add_retrieve_cumulative / add_retrieve_financial share the SimpleProperty / CumulativeProperty / FinancialProperty IDs above.

• BasicProperty basic properties

  name	Meaning	Notes
  1101	CODE Stock code	sval
  1102	NAME Stock name	sval
  1103	INDUSTRY Industry	sval

Each result fills sval(1) / ival(2) / aval(3) / dval(4) according to its value_type. When ival is an enum code, enum_name is decoded by the SDK (e.g. K-line shape returns 'DOUBLE_BOTTOMS').

Option Screening - OptUnderlyingIndicator

Used by add_underlying_filter(indicator_type, ...) and add_underlying_retrieve(indicator_type) of get_option_screen.

indicator_type	Meaning	Notes
101	STOCK_LIST Specified underlying range	Pass a list of security code strings directly in values, e.g. ["US.AAPL", "HK.00700"]
103	PLATE Specified plate	Not yet supported on the backend; passing it raises an error
106	INDEX_LIST Specified index type
201	VOLUME Total volume
202	OPEN_INTEREST Total open interest
203	IV Underlying implied volatility
204	HV Underlying historical volatility
205	IV_RANK
206	IV_PERCENTILE
207 / 208	IV_CHANGE / IV_CHANGE_RATIO
209 / 210	IV_HV_RATIO / IV_HV_SPREAD
401	MARKET_CAP Underlying market cap
402	STOCK_PRICE Underlying last price
403	CHANGE_RATIO Change ratio

Option Screening - OptIndicator

Used by add_option_filter(indicator_type, ...) and add_option_retrieve(indicator_type).

indicator_type	Meaning	Notes
1001	STRIKE_PRICE Strike price
1002	LEFT_DAY Days to expiration
1003	OPTION_TYPE Option type	1=CALL, 2=PUT
1004	EXERCISE_TYPE Exercise type	1=American, 2=European
1005	EXPIRATION_TYPE Expiration type	1=Weekly, 2=Monthly, 3=Quarterly
1007	STRIKE_DATE_TIMESTAMP Maturity date timestamp (seconds)
2001	IN_THE_MONEY	0=OTM, 1=ITM
2002~2005	PRICE / MID_PRICE / BID_PRICE / ASK_PRICE
2006~2009	BID_ASK_SPREAD / BID_VOLUME / ASK_VOLUME / BID_ASK_VOLUME_RATIO
2010	CHANGE_RATIO Change ratio
2011 / 2012	VOLUME / TURNOVER
2013 / 2014	OPEN_INTEREST / OPEN_INTEREST_MARKET_CAP
2018	VOL_OI_RATIO
2021	PREMIUM	Only sort/retrieve, filter is not supported
3001 / 3002 / 3003	IMPLIED_VOLATILITY / HISTORY_VOLATILITY / IV_HV_RATIO
3004~3008	DELTA / GAMMA / VEGA / THETA / RHO
3009 / 3010	LEVERAGE_RATIO / EFFECTIVE_GEARING
3011 / 3012	BUY_TO_BEP / SELL_TO_BEP
3013 / 3014	BUY_PROFIT_PROBABILITY / SELL_PROFIT_PROBABILITY
3015~3018	INTRINSIC_VALUE_PER / TIME_VALUE_PER / ITM_DEGREE / OTM_DEGREE
3019 / 3020	ITM_PROBABILITY / OTM_PROBABILITY

Warrant Screening V2 - WarrantField

Used by add_interval_filter(field_id, ...) / add_choice_filter(field_id, choices) / add_sort(field_id, desc) of get_warrant_screen. All numeric fields accept raw values.

field_id	Meaning	Filter type
1	CODE Security code	choice (text)
2	NAME Stock name	choice (text)
4	ISSUER_ID Issuer ID	choice
5	STOCK_OWNER Underlying stock ID	choice (accepts "HK.00700")
6	WARRANT_TYPE Warrant type	choice: 1=Call, 2=Put, 3=Bull, 4=Bear, 5=Inline
7	CONVERSION_RATIO Conversion ratio	interval
8	CURRENT_PRICE Current price	interval
9	STREET_RATIO Street ratio	interval
10	VOLUME	interval
11	MATURITY_DATE Maturity date (timestamp seconds)	interval
12	STRIKE_PRICE Strike price	interval
13	PREMIUM	interval (can be negative)
14	RECOVERY_PRICE Recovery price	interval
15	IMPLIED_VOLATILITY	interval
16	LEVERAGE_RATIO	interval
17	PRICE_RECOVERY_RATIO Underlying distance to recovery price %	interval
18	DELTA	interval
19	STATUS Warrant status	choice: 0=Normal, 1=Suspended, 2=Pre-IPO
20	IPO_TIME Listing time (timestamp seconds)	interval
21 / 22	BUY_VOL / SELL_VOL Bid / Ask volume	interval
23	EFFECTIVE_LEVERAGE	interval
24	LAST_CLOSE_PRICE Previous close	interval
25	TURNOVER	interval
26 / 27	SELL_PRICE / BUY_PRICE	interval
28 / 29	HIGH_PRICE / LOW_PRICE	interval
30	RATIO_ITM_OTM In/Out of the money	interval (can be negative)
31	BREAK_EVEN_POINT	interval
32	AMPLITUDE	interval
33	SCORE_FAXING SG score	interval
34	LAST_TRADE_DATE Last trade date (timestamp seconds)	interval
35	STREET_VOLUME Street volume	interval
36	LOT_SIZE Lot size	interval
37	ISSUE_SIZE Issue size	interval
38	IPO_PRICE IPO price	interval
39 / 40	LOWER_STRIKE_PRICE / UPPER_STRIKE_PRICE	interval (Inline only)
41	IW_PRICE_STATUS Inside / outside the range	choice
42	SENSITIVITY	interval
43	CONVERSION_PRICE Conversion price	interval
44 / 45	CHANGE_RATE / CHANGE_VALUE Change ratio / amount	interval
51	SCORE Composite score	interval
52	FILTER_NO_TRADE Filter out warrants with no trades	choice: 0=No, 1=Yes
53	CURRENCY_CODE Currency	choice
54	STOCK_OWNER_PRICE Underlying stock price	interval

Warrant Screening V2 - WarrantMarket / WarrantType / WarrantStatus

Common enums for WarrantScreenRequest(warrant_market=...) and add_choice_filter.

• WarrantMarket

  market	Meaning
  1	HK Hong Kong
  4	SG Singapore
  15	MY Malaysia

• WarrantType (choice values for field_id=6)

  value	Meaning
  1	CALL
  2	PUT
  3	BULL
  4	BEAR
  5	INLINE

• WarrantStatus (choice values for field_id=19)

  value	Meaning
  0	NORMAL
  1	SUSPEND Suspended
  2	PRE_IPO Pre-IPO

Option Market Type

• Python
• Proto

OptionMarket

• UNKNOWN

  Unknown

• US_SECURITY

  US Equity Options

• US_INDEX

  US Index Options

• HK_SECURITY

  HK Equity Options

• HK_INDEX

  HK Index Options

OptionMarket

enum OptionMarket
{
    OptionMarket_Unknown = 0; //Unknown
    OptionMarket_US_Security = 1; //US Equity Options
    OptionMarket_US_Index = 2; //US Index Options
    OptionMarket_HK_Security = 3; //HK Equity Options
    OptionMarket_HK_Index = 4; //HK Index Options
}

Option Statistic Data Type

• Python
• Proto

OptionStatisticDataType

• UNKNOWN

  Unknown

• VOLUME

  Volume

• OPEN_INTEREST

  Open Interest

OptionStatisticDataType

enum OptionStatisticDataType
{
    OptionStatisticDataType_Unknown = -1; //Unknown
    OptionStatisticDataType_Volume = 0; //Volume
    OptionStatisticDataType_OpenInterest = 1; //Open Interest
}

Option HV Time Range

• Python
• Proto

OptionHVTimeRange

• UNKNOWN

  Unknown

• THIRTY_DAY

  30 Days

• SIXTY_DAY

  60 Days

• NINETY_DAY

  90 Days

• ONE_TWENTY_DAY

  120 Days

• THREE_SIXTY_FIVE_DAY

  365 Days

OptionHVTimeRange

enum OptionHVTimeRange
{
    OptionHVTimeRange_Unknown = 0; //Unknown
    OptionHVTimeRange_30Day = 1; //30 Days
    OptionHVTimeRange_60Day = 2; //60 Days
    OptionHVTimeRange_90Day = 3; //90 Days
    OptionHVTimeRange_120Day = 4; //120 Days
    OptionHVTimeRange_365Day = 5; //365 Days
}

Option Rank Type

• Python
• Proto

OptionRankType

• UNKNOWN

  Unknown

• VOLUME

  Volume

• TURNOVER

  Turnover

• OI

  Open Interest

• OI_INCREMENT

  OI Increment (Daily)

• OI_DECREMENT

  OI Decrement (Daily)

• OI_MARKET_CAP

  OI Market Cap

• OI_MARKET_CAP_INCREMENT

  OI Market Cap Increment (Daily)

• OI_MARKET_CAP_DECREMENT

  OI Market Cap Decrement (Daily)

• CHANGE_RATE

  Change Rate

• IV

  Implied Volatility

OptionRankType

enum OptionRankType
{
    OptionRankType_Unknown = 0; //Unknown
    OptionRankType_Volume = 1; //Volume
    OptionRankType_Turnover = 2; //Turnover
    OptionRankType_OI = 3; //Open Interest
    OptionRankType_OIIncrement = 4; //OI Increment (Daily)
    OptionRankType_OIDecrement = 5; //OI Decrement (Daily)
    OptionRankType_OIMarketCap = 6; //OI Market Cap
    OptionRankType_OIMarketCapIncrement = 7; //OI Market Cap Increment (Daily)
    OptionRankType_OIMarketCapDecrement = 8; //OI Market Cap Decrement (Daily)
    OptionRankType_ChangeRate = 9; //Change Rate
    OptionRankType_IV = 10; //Implied Volatility
}

Zero DTE Sort Type

• Python
• Proto

ZeroDteSortType

• UNKNOWN

  Unknown

• VOLUME

  Option Volume

• IV

  Implied Volatility

• CHANGE_RATE

  Change Rate

• OPEN_INTEREST

  Open Interest

• MARKET_CAP

  Market Cap

ZeroDteSortType

enum ZeroDteSortType
{
    ZeroDteSortType_Unknown = 0; //Unknown
    ZeroDteSortType_Volume = 1; //Option Volume
    ZeroDteSortType_IV = 2; //Implied Volatility
    ZeroDteSortType_ChangeRate = 3; //Change Rate
    ZeroDteSortType_OpenInterest = 4; //Open Interest
    ZeroDteSortType_MarketCap = 5; //Market Cap
}

Zero DTE Indicator Type

• Python
• Proto

ZeroDteIndicatorType

• UNKNOWN

  Unknown

• OWNER_LIST

  Watchlist

• HAS_EARNINGS_THIS_WEEK

  Has Earnings This Week (0=All, 1=Yes, 2=No)

• VOLUME

  Total Option Volume

• OPEN_INTEREST

  Total Open Interest

• IV

  Implied Volatility(%)

• HV

  Historical Volatility(%)

• IV_RANK

  IV Rank(%)

• IV_PERCENTILE

  IV Percentile(%)

• PRICE

  Last Price

• CHANGE_RATE

  Change Rate(%)

ZeroDteIndicatorType

enum ZeroDteIndicatorType
{
    ZeroDteIndicatorType_Unknown = 0; //Unknown
    ZeroDteIndicatorType_OwnerList = 1; //Watchlist
    ZeroDteIndicatorType_HasEarningsThisWeek = 2; //Has Earnings This Week
    ZeroDteIndicatorType_Volume = 3; //Total Option Volume
    ZeroDteIndicatorType_OpenInterest = 4; //Total Open Interest
    ZeroDteIndicatorType_IV = 5; //Implied Volatility(%)
    ZeroDteIndicatorType_HV = 6; //Historical Volatility(%)
    ZeroDteIndicatorType_IVRank = 7; //IV Rank(%)
    ZeroDteIndicatorType_IVPercentile = 8; //IV Percentile(%)
    ZeroDteIndicatorType_Price = 9; //Last Price
    ZeroDteIndicatorType_ChangeRate = 10; //Change Rate(%)
}

Zero DTE Contract Sort Type

• Python
• Proto

ZeroDteContractSortType

• UNKNOWN

  Unknown

• VOLUME

  Volume

• OPEN_INTEREST

  Open Interest

• IV

  Implied Volatility

• DELTA

  Delta

ZeroDteContractSortType

enum ZeroDteContractSortType
{
    ZeroDteContractSortType_Unknown = 0; //Unknown
    ZeroDteContractSortType_Volume = 1; //Volume
    ZeroDteContractSortType_OpenInterest = 2; //Open Interest
    ZeroDteContractSortType_IV = 3; //Implied Volatility
    ZeroDteContractSortType_Delta = 4; //Delta
}

Zero DTE Contract Indicator Type

• Python
• Proto

ZeroDteContractIndicatorType

• UNKNOWN

  Unknown

• OPTION_TYPE

  Option Direction (1=Call, 2=Put)

• VOLUME

  Volume

• OPEN_INTEREST

  Open Interest

• IV

  Implied Volatility(%)

• DELTA

  Delta

• GAMMA

  Gamma

• THETA

  Theta

• VEGA

  Vega

• RHO

  Rho

• PRICE

  Last Price

• CHANGE_RATE

  Change Rate(%)

• BREAK_EVEN_POINT

  Break Even Point

• TO_BEP

  Distance to BEP(%)

• BUY_PROFIT_PROBABILITY

  Buy Profit Probability(%)

• SELL_PROFIT_PROBABILITY

  Sell Profit Probability(%)

ZeroDteContractIndicatorType

enum ZeroDteContractIndicatorType
{
    ZeroDteContractIndicatorType_Unknown = 0; //Unknown
    ZeroDteContractIndicatorType_OptionType = 1; //Option Direction(1=Call,2=Put)
    ZeroDteContractIndicatorType_Volume = 2; //Volume
    ZeroDteContractIndicatorType_OpenInterest = 3; //Open Interest
    ZeroDteContractIndicatorType_IV = 4; //Implied Volatility(%)
    ZeroDteContractIndicatorType_Delta = 5; //Delta
    ZeroDteContractIndicatorType_Gamma = 6; //Gamma
    ZeroDteContractIndicatorType_Theta = 7; //Theta
    ZeroDteContractIndicatorType_Vega = 8; //Vega
    ZeroDteContractIndicatorType_Rho = 9; //Rho
    ZeroDteContractIndicatorType_Price = 10; //Last Price
    ZeroDteContractIndicatorType_ChangeRate = 11; //Change Rate(%)
    ZeroDteContractIndicatorType_BreakEvenPoint = 12; //Break Even Point
    ZeroDteContractIndicatorType_ToBep = 13; //Distance to BEP(%)
    ZeroDteContractIndicatorType_BuyProfitProbability = 14; //Buy Profit Probability(%)
    ZeroDteContractIndicatorType_SellProfitProbability = 15; //Sell Profit Probability(%)
}

Earnings Sort Type

• Python
• Proto

EarningsSortType

• UNKNOWN

  Unknown

• EARNINGS_DATE

  Earnings Date (Default)

• VOLUME

  Option Volume

• IV

  Implied Volatility

• MARKET_CAP

  Market Cap

• CHANGE_RATIO

  Change Rate

• PRICE

  Last Price

• IV_RANK

  IV Rank

• IV_PERCENTILE

  IV Percentile

• HV

  Historical Volatility

• OPEN_INTEREST

  Open Interest

• LAST_REPORT_IV_CRUSH

  Last IV Crush

• HISTORY_REPORT_IV_CRUSH

  Historical IV Crush

• LAST_REPORT_CHG_RATIO

  Last Earnings Day Change

• HISTORY_REPORT_CHG_RATIO

  Historical Earnings Day Change

• ESTIMATE_EPS_YOY

  Estimated EPS YoY

• ESTIMATE_REVENUE_YOY

  Estimated Revenue YoY

• EXPECTED_MOVE_RATIO

  Expected Move

EarningsSortType

enum EarningsSortType
{
    EarningsSortType_Unknown = 0; //Unknown
    EarningsSortType_EarningsDate = 1; //Earnings Date (Default)
    EarningsSortType_Volume = 2; //Option Volume
    EarningsSortType_IV = 3; //Implied Volatility
    EarningsSortType_MarketCap = 4; //Market Cap
    EarningsSortType_ChangeRate = 5; //Change Rate
    EarningsSortType_Price = 6; //Last Price
    EarningsSortType_IVRank = 7; //IV Rank
    EarningsSortType_IVPercentile = 8; //IV Percentile
    EarningsSortType_HV = 9; //Historical Volatility
    EarningsSortType_OpenInterest = 10; //Open Interest
    EarningsSortType_LastReportIvCrush = 11; //Last IV Crush
    EarningsSortType_HistoryReportIvCrush = 12; //Historical IV Crush
    EarningsSortType_LastReportChgRate = 13; //Last Earnings Day Change
    EarningsSortType_HistoryReportChgRate = 14; //Historical Earnings Day Change
    EarningsSortType_EstimateEpsYoy = 15; //Estimated EPS YoY
    EarningsSortType_EstimateRevenueYoy = 16; //Estimated Revenue YoY
    EarningsSortType_ExpectedMoveRatio = 17; //Expected Move
}

Stock Category

• Python
• Proto

StockCategory

• ALL

  All

• EQUITY

  Equity

• ETF

  ETF

StockCategory

enum StockCategory
{
    StockCategory_All = 0; //All
    StockCategory_Equity = 1; //Equity
    StockCategory_ETF = 2; //ETF
}

Earnings Publication Type

• Python
• Proto

EarningsPubType

• UNKNOWN

  Unknown

• BEFORE

  Pre-market

• AFTER

  After-hours

EarningsPubType

enum EarningsPubType
{
    EarningsPubType_Unknown = 0; //Unknown
    EarningsPubType_Before = 1; //Pre-market
    EarningsPubType_After = 2; //After-hours
}

Earnings Indicator Type

• Python
• Proto

EarningsIndicatorType

• UNKNOWN

  Unknown

• OWNER_LIST

  Watchlist

• INDEX_COMPONENT

  Index Component

• PLATE

  Industry/Sector

• MARKET_CAP

  Market Cap

• EXPIRATION_TYPE

  Expiration Type

• IV

  Implied Volatility(%)

• LAST_REPORT_IV_CRUSH

  Last IV Crush(%)

• HISTORY_REPORT_IV_CRUSH

  Historical IV Crush(%)

• IV_RANK

  IV Rank(%)

• IV_PERCENTILE

  IV Percentile(%)

• VOLUME

  Option Volume

• OPEN_INTEREST

  Open Interest

• PRICE

  Last Price

• CHANGE_RATIO

  Change Rate(%)

• EXPECTED_MOVE_RATIO

  Expected Move(%)

• LAST_REPORT_CHG_RATIO

  Last Earnings Day Change(%)

• HISTORY_REPORT_CHG_RATIO

  Historical Earnings Day Change(%)

• ESTIMATE_REVENUE_YOY

  Estimated Revenue YoY(%)

• ESTIMATE_EPS_YOY

  Estimated EPS YoY(%)

• EARNINGS_DAY_RANGE

  Days to Earnings

EarningsIndicatorType

enum EarningsIndicatorType
{
    EarningsIndicatorType_Unknown = 0; //Unknown
    EarningsIndicatorType_OwnerList = 1; //Watchlist
    EarningsIndicatorType_IndexComponent = 2; //Index Component
    EarningsIndicatorType_Plate = 3; //Industry/Sector
    EarningsIndicatorType_MarketCap = 4; //Market Cap
    EarningsIndicatorType_ExpirationType = 5; //Expiration Type
    EarningsIndicatorType_IV = 6; //Implied Volatility(%)
    EarningsIndicatorType_LastReportIvCrush = 7; //Last IV Crush(%)
    EarningsIndicatorType_HistoryReportIvCrush = 8; //Historical IV Crush(%)
    EarningsIndicatorType_IVRank = 9; //IV Rank(%)
    EarningsIndicatorType_IVPercentile = 10; //IV Percentile(%)
    EarningsIndicatorType_Volume = 11; //Option Volume
    EarningsIndicatorType_OpenInterest = 12; //Open Interest
    EarningsIndicatorType_Price = 13; //Last Price
    EarningsIndicatorType_ChangeRate = 14; //Change Rate(%)
    EarningsIndicatorType_ExpectedMoveRatio = 15; //Expected Move(%)
    EarningsIndicatorType_LastReportChgRate = 16; //Last Earnings Day Change(%)
    EarningsIndicatorType_HistoryReportChgRate = 17; //Historical Earnings Day Change(%)
    EarningsIndicatorType_EstimateRevenueYoy = 18; //Estimated Revenue YoY(%)
    EarningsIndicatorType_EstimateEpsYoy = 19; //Estimated EPS YoY(%)
    EarningsIndicatorType_EarningsDayRange = 20; //Days to Earnings
}

Seller Type

• Python
• Proto

SellerType

• UNKNOWN

  Unknown

• COVERED_CALL

  Covered Call

• CASH_SECURED_PUT

  Cash Secured Put

SellerType

enum SellerType
{
    SellerType_Unknown = 0; //Unknown
    SellerType_CoveredCall = 1; //Covered Call
    SellerType_CashSecuredPut = 2; //Cash Secured Put
}

Seller Sort Type

• Python
• Proto

SellerSortType

• UNKNOWN

  Unknown

• ANNUALIZED_RETURN

  Annualized Return (Default)

• INTERVAL_RETURN

  Interval Return

• ITM_PROBABILITY

  ITM Probability

• PREMIUM

  Premium

SellerSortType

enum SellerSortType
{
    SellerSortType_Unknown = 0; //Unknown
    SellerSortType_AnnualizedReturn = 1; //Annualized Return (Default)
    SellerSortType_IntervalReturn = 2; //Interval Return
    SellerSortType_ItmProbability = 3; //ITM Probability
    SellerSortType_Premium = 4; //Premium
}

Seller Indicator Type

• Python
• Proto

SellerIndicatorType

• UNKNOWN

  Unknown

• OWNER_LIST

  Watchlist

• STOCK_CATEGORY

  Stock Category

• VOLUME

  Total Option Volume

• OPEN_INTEREST

  Total Open Interest

• IV

  Underlying IV(%)

• HV

  Underlying HV(%)

• IV_RANK

  IV Rank(%)

• IV_PERCENTILE

  IV Percentile(%)

• MARKET_CAP

  Market Cap

• PRICE

  Last Price

• CHANGE_RATE

  Change Rate(%)

• PLATE

  Sector

• EXPIRATION_TYPE

  Expiration Type

• LEFT_DAYS

  Days to Expiry

• OPTION_TYPE

  Option Direction (1=Call, 2=Put)

• OPTION_EXPIRATION_TYPE

  Option Expiration Type

• STRIKE_DATE_TIMESTAMP

  Expiry Date Timestamp (sec)

• PREMIUM

  Premium

• ANNUALIZED_RETURN

  Annualized Return(%)

• INTERVAL_RETURN

  Interval Return(%)

• OTM_DEGREE

  OTM Degree(%)

• OTM_PROBABILITY

  OTM Probability(%)

• OPTION_IV

  Option IV(%)

• BID_PRICE

  Bid Price

• ASK_PRICE

  Ask Price

• OPTION_VOLUME

  Option Volume

• OPTION_OPEN_INTEREST

  Option Open Interest

SellerIndicatorType

enum SellerIndicatorType
{
    SellerIndicatorType_Unknown = 0; //Unknown
    SellerIndicatorType_OwnerList = 1; //Watchlist
    SellerIndicatorType_StockCategory = 2; //Stock Category
    SellerIndicatorType_Volume = 3; //Total Option Volume
    SellerIndicatorType_OpenInterest = 4; //Total Open Interest
    SellerIndicatorType_IV = 5; //Underlying IV(%)
    SellerIndicatorType_HV = 6; //Underlying HV(%)
    SellerIndicatorType_IVRank = 7; //IV Rank(%)
    SellerIndicatorType_IVPercentile = 8; //IV Percentile(%)
    SellerIndicatorType_MarketCap = 9; //Market Cap
    SellerIndicatorType_Price = 10; //Last Price
    SellerIndicatorType_ChangeRate = 11; //Change Rate(%)
    SellerIndicatorType_Plate = 12; //Sector
    SellerIndicatorType_ExpirationType = 13; //Expiration Type
    SellerIndicatorType_LeftDays = 14; //Days to Expiry
    SellerIndicatorType_OptionType = 15; //Option Direction(1=Call,2=Put)
    SellerIndicatorType_OptionExpirationType = 16; //Option Expiration Type
    SellerIndicatorType_StrikeDateTimestamp = 17; //Expiry Date Timestamp(sec)
    SellerIndicatorType_Premium = 18; //Premium
    SellerIndicatorType_AnnualizedReturn = 19; //Annualized Return(%)
    SellerIndicatorType_IntervalReturn = 20; //Interval Return(%)
    SellerIndicatorType_OtmDegree = 21; //OTM Degree(%)
    SellerIndicatorType_OtmProbability = 22; //OTM Probability(%)
    SellerIndicatorType_OptionIV = 23; //Option IV(%)
    SellerIndicatorType_BidPrice = 24; //Bid Price
    SellerIndicatorType_AskPrice = 25; //Ask Price
    SellerIndicatorType_OptionVolume = 26; //Option Volume
    SellerIndicatorType_OptionOpenInterest = 27; //Option Open Interest
}

Underlying Rank Sort Type

• Python
• Proto

UnderlyingRankSortType

• UNKNOWN

  Unknown

• VOLUME

  Total Volume

• VOLUME_RATIO

  Put/Call Volume Ratio

• OPEN_INTEREST

  Total Open Interest

• OPEN_INTEREST_RATIO

  Put/Call OI Ratio

• PRICE

  Last Price

• PRICE_CHANGE

  Change Rate

• IV

  IV

• IV_CHANGE

  IV Change

• HV

  HV

• HV_CHANGE

  HV Change

• IV_RANK

  IV Rank

• IV_PERCENTILE

  IV Percentile

• MARKET_CAP

  Market Cap

UnderlyingRankSortType

enum UnderlyingRankSortType
{
    UnderlyingRankSortType_Unknown = 0; //Unknown
    UnderlyingRankSortType_Volume = 1; //Total Volume
    UnderlyingRankSortType_VolumeRatio = 2; //Put/Call Volume Ratio
    UnderlyingRankSortType_OpenInterest = 3; //Total Open Interest
    UnderlyingRankSortType_OpenInterestRatio = 4; //Put/Call OI Ratio
    UnderlyingRankSortType_Price = 5; //Last Price
    UnderlyingRankSortType_PriceChange = 6; //Change Rate
    UnderlyingRankSortType_IV = 7; //IV
    UnderlyingRankSortType_IVChange = 8; //IV Change
    UnderlyingRankSortType_HV = 9; //HV
    UnderlyingRankSortType_HVChange = 10; //HV Change
    UnderlyingRankSortType_IVRank = 11; //IV Rank
    UnderlyingRankSortType_IVPercentile = 12; //IV Percentile
    UnderlyingRankSortType_MarketCap = 13; //Market Cap
}

Underlying Rank Indicator Type

• Python
• Proto

UnderlyingRankIndicatorType

• UNKNOWN

  Unknown

• OWNER_LIST

  Watchlist

• STOCK_CATEGORY

  Stock Category

• VOLUME

  Total Volume

• OPEN_INTEREST

  Total Open Interest

• IV

  IV(%)

• HV

  HV(%)

• IV_RANK

  IV Rank(%)

• IV_PERCENTILE

  IV Percentile(%)

• IV_CHANGE

  IV Change(%)

• HV_CHANGE

  HV Change(%)

• VOLUME_RATIO

  Volume P/C Ratio(%)

• OI_RATIO

  OI P/C Ratio(%)

• MARKET_CAP

  Market Cap

• PRICE

  Last Price

• CHANGE_RATE

  Change Rate(%)

UnderlyingRankIndicatorType

enum UnderlyingRankIndicatorType
{
    UnderlyingRankIndicatorType_Unknown = 0; //Unknown
    UnderlyingRankIndicatorType_OwnerList = 1; //Watchlist
    UnderlyingRankIndicatorType_StockCategory = 2; //Stock Category
    UnderlyingRankIndicatorType_Volume = 3; //Total Volume
    UnderlyingRankIndicatorType_OpenInterest = 4; //Total Open Interest
    UnderlyingRankIndicatorType_IV = 5; //IV(%)
    UnderlyingRankIndicatorType_HV = 6; //HV(%)
    UnderlyingRankIndicatorType_IVRank = 7; //IV Rank(%)
    UnderlyingRankIndicatorType_IVPercentile = 8; //IV Percentile(%)
    UnderlyingRankIndicatorType_IVChange = 9; //IV Change(%)
    UnderlyingRankIndicatorType_HVChange = 10; //HV Change(%)
    UnderlyingRankIndicatorType_VolumeRatio = 11; //Volume P/C Ratio(%)
    UnderlyingRankIndicatorType_OIRatio = 12; //OI P/C Ratio(%)
    UnderlyingRankIndicatorType_MarketCap = 13; //Market Cap
    UnderlyingRankIndicatorType_Price = 14; //Last Price
    UnderlyingRankIndicatorType_ChangeRate = 15; //Change Rate(%)
}

Option Rank Indicator Type

• Python
• Proto

OptionRankIndicatorType

• UNKNOWN

  Unknown

• STOCK_CATEGORY

  Stock Category

• MARKET_CAP

  Market Cap

• OWNER_LIST

  Watchlist

• UNDERLYING_IV

  Underlying IV(%)

• UNDERLYING_HV

  Underlying HV(%)

• IV_RANK

  IV Rank(%)

• IV_PERCENTILE

  IV Percentile(%)

• IV

  Implied Volatility(%)

• OPTION_TYPE

  Direction (Call/Put)

• LEFT_DAYS

  Days to Expiry

• IN_THE_MONEY

  ITM/OTM (0=OTM, 1=ITM)

• VOLUME

  Volume

• OPEN_INTEREST

  Open Interest

• DELTA

  Delta

• GAMMA

  Gamma

• THETA

  Theta

• VEGA

  Vega

• RHO

  Rho

OptionRankIndicatorType

enum OptionRankIndicatorType
{
    OptionRankIndicatorType_Unknown = 0; //Unknown
    OptionRankIndicatorType_StockCategory = 1; //Stock Category
    OptionRankIndicatorType_MarketCap = 2; //Market Cap
    OptionRankIndicatorType_OwnerList = 3; //Watchlist
    OptionRankIndicatorType_UnderlyingIV = 4; //Underlying IV(%)
    OptionRankIndicatorType_UnderlyingHV = 5; //Underlying HV(%)
    OptionRankIndicatorType_IVRank = 6; //IV Rank(%)
    OptionRankIndicatorType_IVPercentile = 7; //IV Percentile(%)
    OptionRankIndicatorType_IV = 8; //Implied Volatility(%)
    OptionRankIndicatorType_OptionType = 9; //Direction(Call/Put)
    OptionRankIndicatorType_LeftDays = 10; //Days to Expiry
    OptionRankIndicatorType_InTheMoney = 11; //ITM/OTM(0=OTM,1=ITM)
    OptionRankIndicatorType_Volume = 12; //Volume
    OptionRankIndicatorType_OpenInterest = 13; //Open Interest
    OptionRankIndicatorType_Delta = 14; //Delta
    OptionRankIndicatorType_Gamma = 15; //Gamma
    OptionRankIndicatorType_Theta = 16; //Theta
    OptionRankIndicatorType_Vega = 17; //Vega
    OptionRankIndicatorType_Rho = 18; //Rho
}

Expiration Type

• Python
• Proto

ExpirationType

• UNKNOWN

  Unknown

• MONTHLY

  Monthly

• WEEKLY

  Weekly

• END_OF_MONTH

  End of Month

• QUARTERLY

  Quarterly

ExpirationType

enum ExpirationType
{
    ExpirationType_Unknown = 0; //Unknown
    ExpirationType_Monthly = 1; //Monthly
    ExpirationType_Weekly = 2; //Weekly
    ExpirationType_EndOfMonth = 3; //End of Month
    ExpirationType_Quarterly = 4; //Quarterly
}

Index Component Type

• Python
• Proto

IndexComponentType

• UNKNOWN

  Unknown

• DJI

  Dow Jones

• IXIC

  NASDAQ Composite

• NDX

  NASDAQ 100

• SPX

  S&P 500

IndexComponentType

enum IndexComponentType
{
    IndexComponentType_Unknown = 0; //Unknown
    IndexComponentType_DJI = 1; //Dow Jones
    IndexComponentType_IXIC = 2; //NASDAQ Composite
    IndexComponentType_NDX = 3; //NASDAQ 100
    IndexComponentType_SPX = 4; //S&P 500
}

Option Event Ticker Direction

• Python
• Proto

EventTickerType

• UNKNOWN

  Unknown

• BUY

  Active Buy

• SELL

  Active Sell

• NEUTRAL

  Neutral

TickerType

enum TickerType
{
    TickerType_Unknown = 0; //Unknown
    TickerType_Buy = 1; //Active Buy
    TickerType_Sell = 2; //Active Sell
    TickerType_Neutral = 3; //Neutral
}

Option Event Order Type

• Python
• Proto

AlertOrderType

• NORMAL

  Normal Order

• SWEEP

  Sweep

• CROSS

  Cross

• FLOOR

  Floor

OptionOrderType

enum OptionOrderType
{
    OptionOrderType_Normal = 0; //Normal Order
    OptionOrderType_Sweep = 1; //Sweep
    OptionOrderType_Cross = 2; //Cross
    OptionOrderType_Floor = 4; //Floor
}

Strategy Type

• Python
• Proto

TickerStrategy

• UNKNOWN

  Unknown

• SINGLE_LEG

  Single Leg

• MULTI_LEG

  Multi Leg

TickerStrategy

enum TickerStrategy
{
    TickerStrategy_Unknown = 0; //Unknown
    TickerStrategy_SingleLeg = 1; //Single Leg
    TickerStrategy_MultiLeg = 2; //Multi Leg
}

Market Sentiment

• Python
• Proto

MarketSentiment

• UNKNOWN

  Unknown

• BEARISH

  Bearish

• BULLISH

  Bullish

• NEUTRAL

  Neutral

MarketSentiment

enum MarketSentiment
{
    MarketSentiment_Unknown = 0; //Unknown
    MarketSentiment_Bearish = 1; //Bearish
    MarketSentiment_Bullish = 2; //Bullish
    MarketSentiment_Neutral = 3; //Neutral
}

Corporate Action Type

• Python
• Proto

CorporateActionType

• NONE

  None/Unknown

• SPLIT

  Stock Split

• JOIN

  Reverse Split

• BONUS_STOCK

  Bonus Share

• INTO_SHARES

  Bonus Issue

• ALLOT

  Rights Issue

• ADD

  Additional Issuance

• DIVIDEND

  Dividend

• SPECIAL_DIVIDEND

  Special Dividend

• SPIN_OFF

  Spin Off

CorporateActionType

enum CorporateActionType
{
    CorporateActionType_None = 0; //None/Unknown
    CorporateActionType_Split = 1; //Stock Split
    CorporateActionType_Join = 2; //Reverse Split
    CorporateActionType_BonusStock = 3; //Bonus Share
    CorporateActionType_IntoShares = 4; //Bonus Issue
    CorporateActionType_Allot = 5; //Rights Issue
    CorporateActionType_Add = 6; //Additional Issuance
    CorporateActionType_Dividend = 7; //Dividend
    CorporateActionType_SpecialDividend = 8; //Special Dividend
    CorporateActionType_SpinOff = 9; //Spin Off
}

In/Out of The Money Type

• Python
• Proto

InTheMoneyType

• UNKNOWN

  Unknown

• IN

  In The Money (ITM)

• OUT

  Out of The Money (OTM)

InTheMoneyType

enum InTheMoneyType
{
    InTheMoneyType_Unknown = 0; //Unknown
    InTheMoneyType_In = 1; //In The Money (ITM)
    InTheMoneyType_Out = 2; //Out of The Money (OTM)
}

Event Indicator Type

• Python
• Proto

EventIndicatorType

• OWNER_LIST

  Underlying list (security_list)

• INDUSTRY_PLATE

  Industry plate list (security_list)

• CONCEPT_PLATE

  Concept plate list (security_list)

• CORPORATE_ACTION

  Corporate action type (value_list, CorporateActionType)

• MARKET_CAP

  Market cap (range)

• OPTION_TYPE

  CALL(1)/PUT(2) (value_list)

• MONEY_TYPE

  ITM(1)/OTM(2) (value_list)

• STRIKE_PRICE

  Strike price (range)

• EXPIRY_DAYS

  Days to expiry (range)

• OTM

  OTM ratio (%) (range)

• TICKER_TYPE

  Ticker direction (value_list, EventTickerType)

• VOLUME

  Volume (range)

• TURNOVER

  Turnover (range)

• PRICE

  Price (range)

• TIME

  Event time (range, Unix seconds)

• MAX_DAY_NUM

  Day range (value_list, 0=today, 1=last 2 days ...)

• ORDER_TYPE

  Order type (value_list, AlertOrderType)

• STRATEGY

  Strategy type (value_list, TickerStrategy)

• SENTIMENT

  Market sentiment (value_list, MarketSentiment)

• TOTAL_VOLUME

  Total option volume (range)

• TOTAL_OI

  Total open interest (range)

• VO_RATIO

  Volume/OI ratio (%) (range)

• IV

  Implied volatility (%) (range)

• DELTA

  Delta (range)

• GAMMA

  Gamma (range)

• VEGA

  Vega (range)

• THETA

  Theta (range)

• RHO

  Rho (range)

EventIndicatorType

enum EventIndicatorType
{
    EventIndicatorType_Unknown = 0;
    // Underlying related
    EventIndicatorType_OwnerList = 101; //Underlying list (securityList)
    EventIndicatorType_IndustryPlate = 102; //Industry plate list (securityList)
    EventIndicatorType_ConceptPlate = 103; //Concept plate list (securityList)
    EventIndicatorType_CorporateAction = 104; //Corporate action type (valueList, CorporateActionType)
    EventIndicatorType_MarketCap = 105; //Market cap (range)
    // Option contract attributes
    EventIndicatorType_OptionType = 201; //CALL(1)/PUT(2) (valueList)
    EventIndicatorType_MoneyType = 202; //ITM(1)/OTM(2) (valueList)
    EventIndicatorType_StrikePrice = 203; //Strike price (range)
    EventIndicatorType_ExpiryDays = 204; //Days to expiry (range)
    EventIndicatorType_OTM = 205; //OTM ratio (%) (range)
    // Ticker info
    EventIndicatorType_TickerType = 301; //Ticker direction (valueList, TickerType)
    EventIndicatorType_Volume = 302; //Volume (range)
    EventIndicatorType_Turnover = 303; //Turnover (range)
    EventIndicatorType_Price = 304; //Price (range)
    EventIndicatorType_Time = 305; //Event time (range, Unix seconds)
    EventIndicatorType_MaxDayNum = 306; //Day range (valueList)
    // Order classification
    EventIndicatorType_OrderType = 401; //Order type (valueList, OptionOrderType)
    EventIndicatorType_Strategy = 402; //Strategy type (valueList, TickerStrategy)
    EventIndicatorType_Sentiment = 403; //Market sentiment (valueList, MarketSentiment)
    // Option statistics
    EventIndicatorType_TotalVolume = 501; //Total option volume (range)
    EventIndicatorType_TotalOI = 502; //Total open interest (range)
    EventIndicatorType_VoRatio = 503; //Volume/OI ratio (%) (range)
    EventIndicatorType_IV = 504; //Implied volatility (%) (range)
    // Greeks
    EventIndicatorType_Delta = 601; //Delta (range)
    EventIndicatorType_Gamma = 602; //Gamma (range)
    EventIndicatorType_Vega = 603; //Vega (range)
    EventIndicatorType_Theta = 604; //Theta (range)
    EventIndicatorType_Rho = 605; //Rho (range)
}

Alert Operation Type

• Python
• Proto

AlertOpType

• UNKNOWN

  Unknown

• ADD

  Add

• DELETE

  Delete

• MODIFY

  Modify

• ENABLE

  Enable

• DISABLE

  Disable

• DELETE_ALL

  Delete All

AlertOpType

enum AlertOpType
{
    AlertOpType_Unknown = 0; //Unknown
    AlertOpType_Add = 1; //Add
    AlertOpType_Delete = 2; //Delete
    AlertOpType_Modify = 3; //Modify
    AlertOpType_Enable = 4; //Enable
    AlertOpType_Disable = 5; //Disable
    AlertOpType_DeleteAll = 6; //Delete All
}