Skip to main content

Definition

TradeStatus - Security Status

Security Status

IDDescription
0Normal
1Suspension
2Delisted
3Fuse
4Papare List
5Code Moved
6To Be Opened
7Split Stock Halts
8Expired
9Warrant To BeListed
10Suspend

Protobuf

enum TradeStatus {
NORMAL = 0;
HALTED = 1;
DELISTED = 2;
FUSE = 3;
PREPARE_LIST = 4;
CODE_MOVED = 5;
TO_BE_OPENED = 6;
SPLIT_STOCK_HALTS = 7;
EXPIRED = 8;
WARRANT_PREPARE_LIST = 9;
SUSPEND_TRADE = 10;
}

TradeSession - Trading Session

Trading Session

IDDescription
0Trading
1Pre-Tradeing
2Post-Tradeing

Protobuf

enum TradeSession {
NORMAL_TRADE = 0;
PRE_TRADE = 1;
POST_TRADE = 2;
}

Period - Candlestick Period

IDDescription
1One Minute
5Five Minutes
15Fifteen Minutes
30Thirty Minutes
60Sixty Minutes
1000One Days
2000One Week
3000One Month
4000One Year

Protobuf

enum Period {
UNKNOWN_PERIOD = 0;
ONE_MINUTE = 1;
FIVE_MINUTE = 5;
FIFTEEN_MINUTE = 15;
THIRTY_MINUTE = 30;
SIXTY_MINUTE = 60;
DAY = 1000;
WEEK = 2000;
MONTH = 3000;
YEAR = 4000;
}

AdjustType - Candlestick Adjustment Type

IDDescription
0Actual
1Adjust forward

Protobuf

enum AdjustType {
NO_ADJUST = 0;
FORWARD_ADJUST = 1;
}

SubType - Quote Type Of Subscription

IDDescription
1Quote
2Depth
3Broker
4Trade

Protobuf

enum SubType {
UNKNOWN_TYPE = 0;
QUOTE = 1;
DEPTH = 2;
BROKERS = 3;
TRADE = 4;
}

CalcIndex - Calculate Index

IDDescriptionApplicable Security Type
1Latest priceAll
2Change valueAll
3Change ratioAll
4VolumeAll
5TurnoverAll
6Year-to-date change ratioExcept Option, Warrant
7Turnover rateExcept Option, Warrant
8Total market valueExcept Option, Warrant
9Capital flowExcept Option, Warrant
10AmplitudeExcept Option, Warrant
11Volume ratioExcept Option, Warrant
12PE (TTM)Except Option, Warrant
13PBExcept Option, Warrant
14Dividend ratio (TTM)Except Option, Warrant
15Five days change ratioExcept Option, Warrant
16Ten days change ratioExcept Option, Warrant
17Half year change ratioExcept Option, Warrant
18Five minutes change ratioExcept Option, Warrant
19Expiry dateOnly Option, Warrant
20Strike PriceOnly Option, Warrant
21Upper bound priceOnly Warrant
22Lower bound priceOnly Warrant
23Outstanding quantityOnly Warrant
24Outstanding ratioOnly Warrant
25PremiumOnly Option, Warrant
26In/out of the boundOnly Warrant
27Implied volatilityOnly Option, Warrant
28Warrant deltaOnly Warrant
29Call priceOnly Warrant
30Price interval from the call priceOnly Warrant
31Effective leverageOnly Warrant
32Leverage ratioOnly Warrant
33Conversion ratioOnly Warrant
34Breakeven pointOnly Warrant
35Open interestOnly Option
36DeltaOnly Option
37GammaOnly Option
38ThetaOnly Option
39VegaOnly Option
40RhoOnly Option

Protobuf

enum CalcIndex {
CALCINDEX_UNKNOWN = 0;
CALCINDEX_LAST_DONE = 1;
CALCINDEX_CHANGE_VAL = 2;
CALCINDEX_CHANGE_RATE = 3;
CALCINDEX_VOLUME = 4;
CALCINDEX_TURNOVER = 5;
CALCINDEX_YTD_CHANGE_RATE = 6;
CALCINDEX_TURNOVER_RATE = 7;
CALCINDEX_TOTAL_MARKET_VALUE = 8;
CALCINDEX_CAPITAL_FLOW = 9;
CALCINDEX_AMPLITUDE = 10;
CALCINDEX_VOLUME_RATIO = 11;
CALCINDEX_PE_TTM_RATIO = 12;
CALCINDEX_PB_RATIO = 13;
CALCINDEX_DIVIDEND_RATIO_TTM = 14;
CALCINDEX_FIVE_DAY_CHANGE_RATE = 15;
CALCINDEX_TEN_DAY_CHANGE_RATE = 16;
CALCINDEX_HALF_YEAR_CHANGE_RATE = 17;
CALCINDEX_FIVE_MINUTES_CHANGE_RATE = 18;
CALCINDEX_EXPIRY_DATE = 19;
CALCINDEX_STRIKE_PRICE = 20;
CALCINDEX_UPPER_STRIKE_PRICE = 21;
CALCINDEX_LOWER_STRIKE_PRICE = 22;
CALCINDEX_OUTSTANDING_QTY = 23;
CALCINDEX_OUTSTANDING_RATIO = 24;
CALCINDEX_PREMIUM = 25;
CALCINDEX_ITM_OTM = 26;
CALCINDEX_IMPLIED_VOLATILITY = 27;
CALCINDEX_WARRANT_DELTA = 28;
CALCINDEX_CALL_PRICE = 29;
CALCINDEX_TO_CALL_PRICE = 30;
CALCINDEX_EFFECTIVE_LEVERAGE = 31;
CALCINDEX_LEVERAGE_RATIO = 32;
CALCINDEX_CONVERSION_RATIO = 33;
CALCINDEX_BALANCE_POINT = 34;
CALCINDEX_OPEN_INTEREST = 35;
CALCINDEX_DELTA = 36;
CALCINDEX_GAMMA = 37;
CALCINDEX_THETA = 38;
CALCINDEX_VEGA = 39;
CALCINDEX_RHO = 40;
}

Board - Security Board

BoardDescription
USMainUS Main Board
USPinkUS Pink Board
USDJIDow Jones Industrial Average
USNSDQNasdsaq Index
USSectorUS Industry Board
USOptionUS Option
USOptionSUS Sepecial Option (market closed at 4:15 pm)
HKEquityHong Kong Equity Securities
HKPreIPOHK PreIPO Security
HKWarrantHK Warrant
HKHSHang Seng Index
HKSectorHK Industry Board
SHMainConnectSH Main Board(Connect)
SHMainNonConnectSH Main Board(Non Connect)
SHSTARSH Science and Technology Innovation Board
CNIXCN Index
CNSectorCN Industry Board
SZMainConnectSZ Main Board(Connect)
SZMainNonConnectSZ Main Board(Non Connect)
SZGEMConnectSZ Gem Board(Connect)
SZGEMNonConnectSZ Gem Board(Non Connect)
SGMainSG Main Board
STISingapore Straits Index
SGSectorSG Industry Board