Securities

import { createClientConfig, QuoteClient } from '@tigeropenapi/tigeropen';

const config = createClientConfig();
const quoteClient = QuoteClient.fromConfig(config);

async getSymbols(req: SymbolsRequest): Promise<string[]>

const result = await quoteClient.getSymbols({ market: 'US', secType: 'STK' });
console.log(result);

[
  "string"
]

async getSymbolNames(req: SymbolsRequest): Promise<SymbolName[]>

const result = await quoteClient.getSymbolNames({ market: 'US' });
console.log(result);

[
  {
    "symbol": "string",
    "name": "string",
    "market": "string"
  }
]

async getTradeMetas(req: TradeMetasRequest): Promise<TradeMeta[]>

const result = await quoteClient.getTradeMetas({ symbols: ['AAPL'] });
console.log(result);

[
  {
    "symbol": "string",
    "lotSize": 0,
    "minTick": 0,
    "spreadScale": 0,
    "shortableFlag": "string",
    "marginableFlag": "string"
  }
]

async getRealTimeQuote(req: BriefRequest): Promise<Brief[]>

const result = await quoteClient.getRealTimeQuote({ symbols: ['AAPL', 'TSLA'] });
console.log(result);

[
  {
    "symbol": "string",
    "open": 0,
    "high": 0,
    "low": 0,
    "close": 0,
    "preClose": 0,
    "latestPrice": 0,
    "latestTime": 0,
    "askPrice": 0,
    "askSize": 0,
    "bidPrice": 0,
    "bidSize": 0,
    "volume": 0,
    "status": "string",
    "adjPreClose": 0,
    "change": 0,
    "changeRate": 0,
    "amplitude": 0,
    "expiry": "string",
    "strike": "string",
    "right": "string",
    "multiplier": 0,
    "openInterest": 0
  }
]

async getDelayedQuote(req: StockDelayBriefsRequest): Promise<Brief[]>

const result = await quoteClient.getDelayedQuote({ symbols: ['AAPL'], secType: 'STK' });
console.log(result);

[
  {
    "symbol": "string",
    "open": 0,
    "high": 0,
    "low": 0,
    "close": 0,
    "preClose": 0,
    "latestPrice": 0,
    "latestTime": 0,
    "askPrice": 0,
    "askSize": 0,
    "bidPrice": 0,
    "bidSize": 0,
    "volume": 0,
    "status": "string",
    "adjPreClose": 0,
    "change": 0,
    "changeRate": 0,
    "amplitude": 0,
    "expiry": "string",
    "strike": "string",
    "right": "string",
    "multiplier": 0,
    "openInterest": 0
  }
]

async getKline(req: KlineRequest): Promise<Kline[]>

const result = await quoteClient.getKline({ symbols: ['AAPL'], period: 'day', limit: 100 });
console.log(result);

[
  {
    "symbol": "string",
    "period": "string",
    "nextPageToken": "string",
    "items": [
      "KlineItem"
    ]
  }
]

async getKlineByPage(req: KlineByPageRequest): Promise<KlineItem[]>

const result = await quoteClient.getKlineByPage({ symbol: 'AAPL', period: 'day', totalSize: 500, pageSize: 200 });
console.log(result);

[
  {
    "time": 0,
    "volume": 0,
    "open": 0,
    "close": 0,
    "high": 0,
    "low": 0,
    "amount": 0
  }
]

async getTimeline(symbols: string[]): Promise<Timeline[]>

const result = await quoteClient.getTimeline(['AAPL']);
console.log(result);

[
  {
    "symbol": "string",
    "period": "string",
    "preClose": 0,
    "intraday": {
      "items": [
        "TimelineItem"
      ]
    },
    "preHours": {
      "items": [
        "TimelineItem"
      ]
    },
    "afterHours": {
      "items": [
        "TimelineItem"
      ]
    }
  }
]

async getTimelineHistory(req: TimelineHistoryRequest): Promise<Timeline[]>

const result = await quoteClient.getTimelineHistory({ symbols: ['AAPL'], date: '2026-01-02' });
console.log(result);

[
  {
    "symbol": "string",
    "period": "string",
    "preClose": 0,
    "intraday": {
      "items": [
        "TimelineItem"
      ]
    },
    "preHours": {
      "items": [
        "TimelineItem"
      ]
    },
    "afterHours": {
      "items": [
        "TimelineItem"
      ]
    }
  }
]

async getTradeTick(req: TradeTickRequest): Promise<TradeTick[]>

const result = await quoteClient.getTradeTick({ symbols: ['AAPL'], limit: 100 });
console.log(result);

[
  {
    "symbol": "string",
    "beginIndex": 0,
    "endIndex": 0,
    "items": [
      "TradeTickItem"
    ]
  }
]

async getQuoteDepth(req: DepthQuoteRequest): Promise<Depth[]>

const result = await quoteClient.getQuoteDepth({ symbols: ['AAPL'], market: 'US' });
console.log(result);

[
  {
    "symbol": "string",
    "asks": [
      "DepthLevel"
    ],
    "bids": [
      "DepthLevel"
    ]
  }
]

async getStockBroker(req: StockBrokerRequest): Promise<StockBroker | undefined>

const result = await quoteClient.getStockBroker({ symbol: '00700', limit: 40, secType: 'STK' });
console.log(result);

{
  "symbol": "string",
  "levelAskList": [
    {
      "level": 0,
      "price": 0,
      "brokers": [
        "BrokerDetail"
      ]
    }
  ],
  "levelBidList": [
    {
      "level": 0,
      "price": 0,
      "brokers": [
        "BrokerDetail"
      ]
    }
  ]
}

async getCapitalFlow(symbol: string, market: string, period: string): Promise<CapitalFlow | undefined>

const result = await quoteClient.getCapitalFlow('AAPL', 'US', 'day');
console.log(result);

{
  "symbol": "string",
  "period": "string",
  "items": [
    {
      "time": "string",
      "timestamp": 0,
      "netInflow": 0
    }
  ]
}

async getCapitalDistribution(symbol: string, market: string): Promise<CapitalDistribution | undefined>

const result = await quoteClient.getCapitalDistribution('AAPL', 'US');
console.log(result);

{
  "symbol": "string",
  "netInflow": 0,
  "inAll": 0,
  "inBig": 0,
  "inMid": 0,
  "inSmall": 0,
  "outAll": 0,
  "outBig": 0,
  "outMid": 0,
  "outSmall": 0
}

async getTradeRank(req: TradeRankRequest): Promise<TradeRankItem[]>

const result = await quoteClient.getTradeRank({ market: 'US' });
console.log(result);

[
  {
    "symbol": "string",
    "name": "string",
    "latestPrice": 0,
    "change": 0,
    "changeRate": 0,
    "volume": 0,
    "amount": 0
  }
]

async getShortInterest(req: ShortInterestRequest): Promise<ShortInterest[]>

const result = await quoteClient.getShortInterest({ symbols: ['AAPL'] });
console.log(result);

[
  {
    "symbol": "string",
    "settlementDate": "string",
    "shortInterest": 0,
    "avgDailyVolume": 0,
    "daysToCover": 0,
    "percentOfFloat": 0,
    "shortInterestPrevious": 0,
    "percentChange": 0
  }
]