Enums and Constants

Enum Types

The C++ SDK enum types are defined in tigerapi/enums.h under the TIGER_API namespace. All enums are enum class types and can be converted to strings using the enum_to_str() function.


Market

enum class Market {
    ALL,  // All
    US,   // United States
    HK,   // Hong Kong
    CN,   // China
    SG    // Singapore
};

Usage Example

Market market = Market::US;
utility::string_t market_str = enum_to_str(market);  // "US"

SecType Security Type

enum class SecType {
    ALL,   // All
    STK,   // Stock
    OPT,   // Option
    WAR,   // Warrant
    IOPT,  // CBBC (Callable Bull/Bear Contract)
    FUT,   // Futures
    FOP,   // Futures Option
    CASH   // Forex
};

Currency

enum class Currency {
    ALL,  // All
    USD,  // US Dollar
    HKD,  // Hong Kong Dollar
    CNH,  // Offshore RMB
    SGD   // Singapore Dollar
};

SegmentType Account Segment

enum class SegmentType {
    ALL,  // All
    SEC,  // Securities
    FUT   // Futures
};

BarPeriod K-line Period

enum class BarPeriod {
    DAY,              // Daily
    WEEK,             // Weekly
    MONTH,            // Monthly
    YEAR,             // Yearly
    ONE_MINUTE,       // 1 minute
    THREE_MINUTES,    // 3 minutes
    FIVE_MINUTES,     // 5 minutes
    TEN_MINUTES,      // 10 minutes
    FIFTEEN_MINUTES,  // 15 minutes
    HALF_HOUR,        // 30 minutes
    FORTY_FIVE_MINUTES, // 45 minutes
    ONE_HOUR,         // 60 minutes
    TWO_HOURS,        // 2 hours
    THREE_HOURS,      // 3 hours
    FOUR_HOURS,       // 4 hours
    SIX_HOURS         // 6 hours
};

String Mapping

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

CapitalPeriod Capital Flow Period

enum class CapitalPeriod {
    INTRADAY,   // Intraday
    DAY,        // Day
    WEEK,       // Week
    MONTH,      // Month
    YEAR,       // Year
    QUARTER,    // Quarter
    HALFAYEAR   // Half year
};

String Mapping

Enum ValueString
INTRADAY"intraday"
DAY"day"
WEEK"week"
MONTH"month"
YEAR"year"
QUARTER"quarter"
HALFAYEAR"6month"

TimelinePeriod Timeline Period

enum class TimelinePeriod {
    DAY = 1,       // Current day timeline
    FIVE_DAYS = 2  // 5-day timeline
};

TradingSession

enum class TradingSession {
    PreMarket,   // Pre-market
    Regular,     // Regular hours
    AfterHours   // After-hours
};

QuoteRight Adjustment Type

enum class QuoteRight {
    br,  // Forward adjusted
    nr   // Unadjusted
};

Right Option Direction

enum class Right {
    PUT,   // Put
    CALL,  // Call
    ALL    // All
};

OrderStatus

enum class OrderStatus {
    PendingNew,      // Pending new
    PendingSubmit,   // Pending submit
    Initial,         // Initial
    Submitted,       // Submitted (unfilled)
    PartiallyFilled, // Partially filled
    Filled,          // Fully filled
    Cancelled,       // Cancelled
    PendingCancel,   // Pending cancel
    Inactive,        // Inactive
    Invalid          // Invalid
};

OrderSortBy Order Sort Method

enum class OrderSortBy {
    LATEST_CREATED,        // Sort by creation time
    LATEST_STATUS_UPDATED  // Sort by status update time
};

License

enum class License {
    TBNZ,  // New Zealand
    TBSG,  // Singapore
    TBHK,  // Hong Kong
    TBAU,  // Australia
    TBUS   // United States
};

Language

enum class Language {
    zh_CN,  // Simplified Chinese
    zh_TW,  // Traditional Chinese
    en_US   // English
};

TickSizeType Tick Size Interval Type

enum class TickSizeType {
    OPEN,         // Open interval (begin, end)
    OPEN_CLOSED,  // Left-open right-closed (begin, end]
    CLOSED_OPEN,  // Left-closed right-open [begin, end)
    CLOSED        // Closed interval [begin, end]
};

Constants

Exchange Part Code Map (PART_CODE_MAP)

CodeExchange AbbreviationExchange Full Name
aAMEXNYSE American, LLC
bBXNASDAQ OMX BX, Inc.
cNSXNYSE National, Inc.
nNYSENew York Stock Exchange, LLC
pARCANYSE Arca, Inc.
tNSDQNASDAQ Stock Market, LLC
vIEXInvestors' Exchange, LLC
zBZXCboe BZX Exchange, Inc.

US Trade Conditions (US_TRADE_COND_MAP)

CodeDescription
(space)Regular Sale
FIntermarket Sweep
IOdd Lot Trade
TForm T (Pre/Post Market)
UExtended Trading Hours
XCross Trade

HK Trade Conditions (HK_TRADE_COND_MAP)

CodeDescription
(space)Automatch Normal Trade
DOdd Lot Trade
UAuction Trade
PLate/Post-close Trade
MNon-automatch Trade
XSame Broker Automatch