@itick/browser-sdk/lib/types/index.d.ts

Official iTick API SDK for browser. Real-time & historical data for global Stocks, Forex, Crypto, Indices, Futures, Funds, Precious Metals. REST (OHLCV/K-line) + low-latency WebSocket. Promise-based, TypeScript-ready. For quant trading & fintech

/**
 * API Response Object
 * Standard response format returned by all API endpoints
 * - code: 0 indicates success, non-0 indicates failure
 * - msg: response message or error information
 * @template T Type of response data
 */
export interface APIResponse<T = any> {
    /** Response status code: 0 indicates success, non-0 indicates failure */
    code: number;
    /** Response message or error information */
    msg: string | null;
    /** Response data */
    data: T;
}
/**
 * Product Information
 * Basic information about a product
 * - c: product code
 * - n: product name
 * - t: product type, such as stock, forex, indices, crypto, future, fund, etc.
 * - e: exchange
 * - Other fields may vary depending on product type
 */
export interface SymbolInfo {
    /** Product code */
    c: string;
    /** Product name */
    n: string;
    /** Type such as stock, forex, indices, crypto, future, fund */
    t: string;
    /** Exchange */
    e: string;
    [key: string]: any;
}
/**
 * Market Holiday
 * Contains market holiday and trading time information
 * - c: market code
 * - r: market name
 * - z: market timezone
 * - t: intraday trading hours, e.g., 09:00-09:30,09:30-12:00|13:00-16:00,16:00-16:30
 *   - 09:00-09:30 represents pre-market trading hours
 *   - 09:30-12:00|13:00-16:00 represents regular trading hours, pipe separator indicates different continuous trading sessions
 *   - 16:00-16:30 represents after-hours trading hours
 * - d: holiday dates within the year
 * - v: holiday name
 */
export interface MarketHoliday {
    /** Market code */
    c: string;
    /** Market name */
    r: string;
    /** Market timezone */
    z: string;
    /** Intraday trading hours */
    t: string;
    /** Holiday dates within the year */
    d: string;
    /** Holiday name */
    v: string;
}
/**
 * Stock Information
 * Contains basic stock information and market data
 * - c: stock code
 * - n: stock name
 * - t: stock type
 * - e: exchange
 * - s: sector
 * - i: industry
 * - l: company logo URL
 * - r: region/country code
 * - bd: company description
 * - wu: company website URL
 * - mcb: market capitalization
 * - tso: total shares outstanding
 * - pet: P/E ratio
 * - fcc: currency code
 */
export interface StockInfo {
    /** Stock code */
    c: string;
    /** Stock name */
    n: string;
    /** Instrument type */
    t: string;
    /** Exchange */
    e: string;
    /** Sector */
    s: string;
    /** Industry */
    i: string;
    /** Company logo URL */
    l: string;
    /** Region/country code */
    r: string;
    /** Company description */
    bd: string;
    /** Company website URL */
    wu: string;
    /** Market capitalization */
    mcb: number;
    /** Total shares outstanding */
    tso: number;
    /** P/E ratio */
    pet: number;
    /** Currency code */
    fcc: string;
}
/**
 * Stock IPO Information
 * Contains IPO subscription information and timing related to stock listing
 * - dt: listing date (timestamp, milliseconds precision)
 * - cn: company name
 * - sc: stock code
 * - ex: exchange name
 * - mc: market cap
 * - pr: price
 * - ct: country code
 * - bs: subscription start time (timestamp, seconds)
 * - es: subscription end time (timestamp, seconds)
 * - ro: result announcement time (timestamp, seconds)
 */
export interface StockIPO {
    /** Listing date (timestamp, milliseconds precision) */
    dt: number;
    /** Company name */
    cn: string;
    /** Stock code */
    sc: string;
    /** Exchange name */
    ex: string;
    /** Market cap */
    mc: string;
    /** Price */
    pr: string;
    /** Country code */
    ct: string;
    /** Subscription start time (timestamp, seconds) */
    bs: number;
    /** Subscription end time (timestamp, seconds) */
    es: number;
    /** Result announcement time (timestamp, seconds) */
    ro: number;
}
/**
 * Stock Split/Consolidation/Adjustment Factor
 * Contains stock split/consolidation adjustment information
 * - d: adjustment date timestamp (unit: milliseconds)
 * - r: country/region code
 * - n: stock name
 * - c: stock code
 * - v: adjustment factor, split/consolidation ratio
 */
export interface StockSplit {
    /** Adjustment date timestamp (unit: milliseconds) */
    d: number;
    /** Country/region code */
    r: string;
    /** Stock name */
    n: string;
    /** Stock code */
    c: string;
    /** Adjustment factor, split/consolidation ratio */
    v: string;
}
//# sourceMappingURL=index.d.ts.map