行情查询

TypeScript SDK 通过 QuoteClient 提供全部行情接口，所有方法均返回强类型对象。请求参数在 TS 中使用 camelCase，SDK 会自动转换为 snake_case 发往服务端。

完整可运行示例：

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

async function main() {
  const config = createClientConfig();
  // 行情客户端需要行情专用的 HttpClient
  const qc = new QuoteClient(
    new HttpClient(config, undefined, { useQuoteServerUrl: true }),
  );

  // 市场状态
  const states = await qc.getMarketState('US');
  console.log('美股市场状态:', states);

  // 实时报价
  const briefs = await qc.getRealTimeQuote({ symbols: ['AAPL', 'TSLA'] });
  console.log('实时报价:', briefs);

  // K 线
  const klines = await qc.getKline({ symbols: ['AAPL'], period: 'day' });
  console.log('K 线:', klines[0]?.items.length);
}

main().catch(console.error);

通用

getMarketState 获取市场状态

qc.getMarketState(market: string): Promise<MarketState[]>

说明

查询指定市场（美股、港股等）的当前交易状态。

参数

返回

Promise<MarketState[]>，每个元素含 market、marketStatus、status、openTime。

示例

const states = await qc.getMarketState('US');
console.log(states);

getTradingCalendar 获取交易日历

qc.getTradingCalendar(req: TradingCalendarRequest): Promise<TradingCalendarItem[]>

请求 TradingCalendarRequest

返回

Promise<TradingCalendarItem[]>（market / date / isTrading / sessionType）。

示例

const cal = await qc.getTradingCalendar({
  market: 'US',
  beginDate: '2025-01-01',
  endDate: '2025-12-31',
});

grabQuotePermission 获取行情权限

qc.grabQuotePermission(): Promise<QuotePermission[]>

说明

查询当前账户开通的行情权限列表。

返回

Promise<QuotePermission[]>，每个元素含 name、expireAt。

示例

const perms = await qc.grabQuotePermission();
console.log(perms);

getQuotePermission 查询行情权限（带日期范围）

qc.getQuotePermission(req: QuotePermissionRequest): Promise<QuotePermission[]>

说明

查询账户行情权限。与无参的 grabQuotePermission 不同：此方法支持传入日期范围，返回历史有效的权限明细。

请求 QuotePermissionRequest

示例

const perms = await qc.getQuotePermission({
  beginDate: '20250101',
  endDate: '20251231',
});

getKlineQuota 查询 K 线调用配额

qc.getKlineQuota(req: KlineQuotaRequest): Promise<KlineQuota[]>

说明

查询 K 线接口剩余调用配额。

请求 KlineQuotaRequest

返回

Promise<KlineQuota[]>（method / used / quota / detail；每个 KlineQuotaDetail 含 symbol / market / usedBars / quotaBars / lastAccess）。

示例

const quota = await qc.getKlineQuota({ withDetails: true });
for (const q of quota) {
  console.log(`${q.method} used=${q.used}/${q.quota}`);
}

股票行情

getSymbols 获取市场全部代码

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

说明

获取指定市场的全部合约代码列表（仅 symbol）。

请求 SymbolsRequest

返回

Promise<string[]> symbol 列表。

示例

const symbols = await qc.getSymbols({ market: 'US' });
console.log(`total=${symbols.length} first=${symbols[0]}`);

getSymbolNames 获取代码 + 名称

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

说明

获取指定市场的合约代码及中英文名称。

返回

Promise<SymbolName[]>（symbol / name / market）。

示例

const items = await qc.getSymbolNames({ market: 'US' });
for (const it of items.slice(0, 5)) {
  console.log(`${it.symbol} ${it.name}`);
}

getTradeMetas 获取交易元数据

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

说明

获取合约的交易元数据（最小变动价位、每手股数、是否可融可空等）。

请求 TradeMetasRequest

返回

Promise<TradeMeta[]>（symbol / lotSize / minTick / spreadScale / shortableFlag / marginableFlag）。

示例

const metas = await qc.getTradeMetas({ symbols: ['AAPL', '00700'] });
for (const m of metas) {
  console.log(`${m.symbol} lot=${m.lotSize} minTick=${m.minTick}`);
}

getRealTimeQuote 获取实时报价

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

说明

批量获取股票的实时快照行情。

请求 BriefRequest

返回

Promise<Brief[]>，每个元素含 symbol、latestPrice、preClose、open/high/low/close、change/changeRate、volume、bidPrice/askPrice、bidSize/askSize、latestTime 等。

示例

const briefs = await qc.getRealTimeQuote({
  symbols: ['AAPL', 'TSLA', '00700'],
});
for (const b of briefs) {
  console.log(`${b.symbol} ${b.latestPrice} (${b.changeRate})`);
}

getDelayedQuote 获取延迟行情

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

说明

获取延迟行情快照（结构与实时 getRealTimeQuote 相同）。

请求 StockDelayBriefsRequest

示例

const briefs = await qc.getDelayedQuote({ symbols: ['AAPL'] });

getKline 获取 K 线数据

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

说明

获取指定股票的历史 K 线数据，支持时间范围、分页、前复权/后复权、盘前盘后等。

请求 KlineRequest

返回

Promise<Kline[]>，每个元素含 symbol、period、items: KlineItem[]（time/open/high/low/close/volume/amount）、可选 nextPageToken。

示例

const klines = await qc.getKline({ symbols: ['AAPL'], period: 'day', limit: 100 });
console.log(klines[0]?.items);

getTimeline 获取分时数据

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

说明

获取当日分时走势数据。

参数

返回

Promise<Timeline[]>，每个元素含 symbol、period、preClose，以及 intraday / preHours / afterHours 三个可选分时桶，每个桶下的 items 含 time、price、volume、avgPrice。

示例

const tl = await qc.getTimeline(['AAPL']);
console.log(tl[0]?.intraday?.items);

getTimelineHistory 获取历史分时

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

说明

获取历史某一交易日的分时数据。

请求 TimelineHistoryRequest

返回

Promise<Timeline[]>（结构同 getTimeline）。

示例

const tl = await qc.getTimelineHistory({
  symbols: ['AAPL'],
  date: '2025-09-01',
});

getTradeTick 获取逐笔成交

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

说明

获取最新逐笔成交记录。

请求 TradeTickRequest

返回

Promise<TradeTick[]>，每个元素含 symbol、beginIndex、endIndex、items（time/price/volume/type）。

示例

const ticks = await qc.getTradeTick({ symbols: ['AAPL'] });
console.log(ticks[0]?.items.slice(0, 5));

getQuoteDepth 获取深度行情

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

说明

获取盘口深度数据。仅支持 'US' / 'HK' 市场。

请求 DepthQuoteRequest

返回

Promise<Depth[]>，每个元素含 symbol、asks、bids；每档 DepthLevel 含 price/count/volume。

示例

const depths = await qc.getQuoteDepth({
  symbols: ['AAPL'],
  market: 'US',
});
console.log(depths[0]?.asks, depths[0]?.bids);

getStockBroker 获取港股经纪商队列

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

说明

获取港股指定股票的经纪商盘口队列（需港股 Level2 牌照）。

请求 StockBrokerRequest

返回

Promise<StockBroker | undefined>（symbol / levelAskList / levelBidList；每档 StockBrokerItem 含 level / price / brokers: BrokerDetail[]）。

示例

const sb = await qc.getStockBroker({ symbol: '00700', limit: 40 });
console.log(`askLevels=${sb?.levelAskList?.length} bidLevels=${sb?.levelBidList?.length}`);

getCapitalFlow 获取资金流向

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

说明

获取股票的资金流向时间序列数据。

参数

返回

Promise<CapitalFlow | undefined>，对象含 symbol、period、items: CapitalFlowItem[]（time/timestamp/netInflow）。

示例

const flow = await qc.getCapitalFlow('AAPL', 'US', 'day');
console.log(flow?.items);

getCapitalDistribution 获取资金分布

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

说明

获取股票当前资金分布快照，按大单/中单/小单维度展示流入流出。

参数

返回

Promise<CapitalDistribution | undefined>，对象含 symbol、netInflow、inAll、inBig、inMid、inSmall、outAll、outBig、outMid、outSmall。

示例

const dist = await qc.getCapitalDistribution('AAPL', 'US');
console.log(dist?.netInflow);

getTradeRank 获取成交排行

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

说明

查询指定市场的成交额/成交量排行榜。

请求 TradeRankRequest

返回

Promise<TradeRankItem[]>（symbol / name / latestPr / change / changeRate / volume / amount）。

示例

const rank = await qc.getTradeRank({ market: 'HK' });
for (const r of rank.slice(0, 10)) {
  console.log(`${r.symbol} ${r.name} amount=${r.amount}`);
}

getShortInterest 获取空头持仓

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

说明

获取美股空头持仓（short interest）数据。

请求 ShortInterestRequest

返回

Promise<ShortInterest[]>（symbol / settlementDate / shortInterest / avgDailyVolume / daysToCover / percentOfFloat / shortInterestPrevious / percentChange）。

示例

const si = await qc.getShortInterest({ symbols: ['TSLA'] });

getStockIndustry 获取股票所属行业

qc.getStockIndustry(req: StockIndustryRequest): Promise<StockIndustry[]>

说明

查询股票所属的 GICS 行业分类。

请求 StockIndustryRequest

返回

Promise<StockIndustry[]>（symbol / gSector / gGroup / gInd / gSubInd / level）。

示例

const si = await qc.getStockIndustry({ symbol: 'AAPL', market: 'US' });

期权行情

所有期权扩展方法均复用 OptionQueryItem 嵌套结构，用于精确定位单份期权合约：

interface OptionQueryItem {
  symbol?: string;
  expiry?: number;   // ms timestamp
  strike?: string;
  right?: string;    // 'CALL' / 'PUT'
  period?: string;   // 仅 K 线 / 分时用到
  beginTime?: number;
  endTime?: number;
  limit?: number;
  beginIndex?: number;
  endIndex?: number;
  pageToken?: string;
}

getOptionSymbols 获取期权代码列表

qc.getOptionSymbols(req: OptionSymbolsRequest): Promise<OptionSymbol[]>

请求 OptionSymbolsRequest：market / lang。

返回

Promise<OptionSymbol[]>（symbol / market / nameCN / nameEN）。

示例

const syms = await qc.getOptionSymbols({ market: 'US' });

getOptionExpiration 获取期权到期日

qc.getOptionExpiration(symbol: string): Promise<OptionExpiration[]>

说明

获取标的的所有期权到期日列表。

参数

返回

Promise<OptionExpiration[]>，每个元素含 symbol、dates（'YYYY-MM-DD' 字符串数组）、timestamps（毫秒时间戳数组），可选 optionSymbols / periods / counts。

示例

const exps = await qc.getOptionExpiration('AAPL');
console.log(exps[0]?.dates);

getOptionChain 获取期权链

qc.getOptionChain(items: Array<[string, string]>, timezone?: string): Promise<OptionChain[]>

说明

批量获取多个标的 / 到期日组合的期权链。timezone 可选，默认按 symbol 推断（.HK → Asia/Hong_Kong，其他 → America/New_York）。

参数

返回

Promise<OptionChain[]>，每个元素含 symbol、expiry、items: OptionChainRow[]。每行含 call、put 两个 OptionLeg，OptionLeg 含 identifier、strike、right、latestPrice、bidPrice/askPrice、impliedVol、delta、gamma、theta、vega 等。

示例

// 美股（自动推断 America/New_York）
const chain = await qc.getOptionChain([['AAPL', '2025-01-17']]);
// 港股（显式指定时区）
const hkChain = await qc.getOptionChain([['00700.HK', '2025-01-17']], 'Asia/Hong_Kong');
const firstRow = chain[0]?.items[0];
console.log(firstRow?.call?.identifier, firstRow?.put?.identifier);

getOptionQuote 获取期权报价

qc.getOptionQuote(identifiers: string[], timezone?: string): Promise<Brief[]>

说明

批量获取期权合约的实时报价；SDK 内部会把 OCC 期权代码解析为 symbol / expiry / right / strike 请求参数。

参数

返回

Promise<Brief[]>，每个元素含 symbol、latestPrice、preClose、change、volume、openInterest、multiplier、expiry（ms 时间戳）、strike、right、askPrice/bidPrice。

示例

const optBriefs = await qc.getOptionQuote(['AAPL  250117C00150000']);
console.log(optBriefs[0]?.latestPrice);

getOptionKline 获取期权 K 线

qc.getOptionKline(identifiers: string[], period: string, beginTime?: number, endTime?: number, timezone?: string): Promise<Kline[]>

说明

获取期权合约的历史 K 线数据。beginTime/endTime 为毫秒时间戳，传 -1 为服务端默认。

参数

返回

Promise<Kline[]>（结构同 getKline）。

示例

const nowMs = Date.now();
const beginMs = nowMs - 30 * 24 * 60 * 60 * 1000; // 近 30 天
const optKline = await qc.getOptionKline(['AAPL  250117C00150000'], 'day', beginMs, nowMs);
console.log(optKline[0]?.items);

getOptionTradeTicks 获取期权逐笔

qc.getOptionTradeTicks(req: OptionTradeTicksRequest): Promise<TradeTick[]>

请求：contracts: OptionQueryItem[] / lang。

示例

const ticks = await qc.getOptionTradeTicks({
  contracts: [{ symbol: 'AAPL', expiry: 1750291200000, // 2025-06-19
    strike: '200', right: 'CALL' }],
});

getOptionTimeline 获取期权分时

qc.getOptionTimeline(req: OptionTimelineRequest): Promise<Timeline[]>

请求：optionQuery: OptionQueryItem[] / market / lang。

getOptionDepth 获取期权盘口

qc.getOptionDepth(req: OptionDepthRequest): Promise<Depth[]>

请求：optionBasic: OptionQueryItem[] / market / lang。

getOptionAnalysis 获取期权波动率分析

qc.getOptionAnalysis(req: OptionAnalysisRequest): Promise<OptionAnalysis[]>

请求 OptionAnalysisRequest

返回

Promise<OptionAnalysis[]>，每个元素包含：

示例

const res = await qc.getOptionAnalysis({
  symbols: ['AAPL'],
  market: 'US',
  period: '26week',
});

期货行情

getFutureExchange 获取期货交易所列表

qc.getFutureExchange(): Promise<FutureExchange[]>

说明

获取平台支持的所有期货交易所列表。

返回

Promise<FutureExchange[]>，每个元素含 code、name、zoneId。

示例

const exchanges = await qc.getFutureExchange();
for (const e of exchanges) {
  console.log(`${e.code} ${e.name} (${e.zoneId})`);
}

getFutureContracts 获取期货合约列表

qc.getFutureContracts(exchangeCode: string): Promise<FutureContractInfo[]>

说明

获取指定交易所下所有可交易期货合约。

参数

返回

Promise<FutureContractInfo[]>，每个元素含 contractCode、name、type、contractMonth、lastTradingDate、currency、multiplier、minTick、exchange。

示例

const contracts = await qc.getFutureContracts('CME');
console.log(contracts[0]?.contractCode);

getFutureContract 按合约代码查合约

qc.getFutureContract(req: FutureContractSingleRequest): Promise<FutureContractInfo[]>

请求 FutureContractSingleRequest：contractCode / type / lang。

示例

const cs = await qc.getFutureContract({ contractCode: 'CL2609' });

getAllFutureContracts 按品种查全部合约

qc.getAllFutureContracts(req: AllFutureContractsRequest): Promise<FutureContractInfo[]>

请求 AllFutureContractsRequest：type / exchange / lang。

示例

const cs = await qc.getAllFutureContracts({ type: 'CL' });

getCurrentFutureContract 查当前主力合约

qc.getCurrentFutureContract(req: FutureContractSingleRequest): Promise<FutureContractInfo | undefined>

示例

const c = await qc.getCurrentFutureContract({ type: 'CL' });
console.log(`current main: ${c?.contractCode}`);

getFutureContinuousContracts 连续合约

qc.getFutureContinuousContracts(req: FutureContinuousContractsRequest): Promise<FutureContractInfo[]>

请求：type / lang。

getFutureHistoryMainContract 主力合约历史

qc.getFutureHistoryMainContract(req: FutureHistoryMainContractRequest): Promise<FutureMainContractHistory[]>

请求 FutureHistoryMainContractRequest

返回

Promise<FutureMainContractHistory[]>（contractCode / symbol / beginDate / endDate）。

getFutureRealTimeQuote 获取期货实时报价

qc.getFutureRealTimeQuote(req: FutureBriefRequest): Promise<FutureQuote[]>

说明

批量获取期货合约的实时行情数据。

请求 FutureBriefRequest

返回

Promise<FutureQuote[]>，每个元素含 contractCode、latestPrice、bidPrice/askPrice、volume、openInterest、open/high/low、settlement、limitUp/limitDown。

示例

const futQuotes = await qc.getFutureRealTimeQuote({
  contractCodes: ['ES2506', 'NQ2506'],
});
console.log(futQuotes);

getFutureKline 获取期货 K 线

qc.getFutureKline(req: FutureKlineRequest): Promise<FutureKline[]>

说明

获取期货合约的历史 K 线数据。beginTime/endTime 为毫秒时间戳；传 -1（或省略后由 SDK 默认填 -1）表示不限制。

请求 FutureKlineRequest

返回

Promise<FutureKline[]>，每个元素含 items: FutureKlineItem[] 与可选 nextPageToken；FutureKlineItem 含 time、open、high、low、close、volume、lastTime、openInterest、settlement。

示例

const futKline = await qc.getFutureKline({
  contractCodes: ['ES2506'],
  period: 'day',
  beginTime: -1,
  endTime: -1,
});
console.log(futKline[0]?.items);

getFutureTradeTicks 获取期货逐笔

qc.getFutureTradeTicks(req: FutureTradeTicksRequest): Promise<FutureTradeTickItem[]>

请求 FutureTradeTicksRequest

返回

Promise<FutureTradeTickItem[]>（contractCode / index / time / price / volume / direction）。

getFutureDepth 获取期货盘口

qc.getFutureDepth(req: FutureDepthRequest): Promise<FutureDepth[]>

请求：contractCodes: string[] / lang。

返回

Promise<FutureDepth[]>（contractCode / timestamp / asks / bids）。

getFutureTradingTimes 获取期货交易时段

qc.getFutureTradingTimes(req: FutureTradingTimesRequest): Promise<FutureTradingTime | undefined>

请求 FutureTradingTimesRequest

返回

Promise<FutureTradingTime | undefined>（contractCode / bizDate / zone / tradingTimes: FutureTradingSegment[]；每段含 start / end / type）。

基金

getFundSymbols 获取基金代码列表

qc.getFundSymbols(req: FundSymbolsRequest): Promise<string[]>

请求：lang。

getFundContracts 获取基金合约资料

qc.getFundContracts(req: FundContractsRequest): Promise<FundContractInfo[]>

请求：symbols: string[] / lang。

返回

Promise<FundContractInfo[]>（symbol / name / currency / fundType / inception / netAssetVal / expenseRatio）。

getFundQuote 获取基金实时净值

qc.getFundQuote(req: FundQuoteRequest): Promise<FundQuote[]>

请求：symbols: string[] / lang。

返回

Promise<FundQuote[]>（symbol / latestNav / change / changeRate / date）。

示例

const q = await qc.getFundQuote({ symbols: ['SPY'] });

getFundHistoryQuote 获取基金历史净值

qc.getFundHistoryQuote(req: FundHistoryQuoteRequest): Promise<FundHistoryQuote[]>

请求 FundHistoryQuoteRequest

返回

Promise<FundHistoryQuote[]>（symbol / date / nav）。

窝轮

getWarrantQuote 获取窝轮报价

qc.getWarrantQuote(req: WarrantBriefsRequest): Promise<WarrantBrief[]>

请求：symbols: string[] / lang。

返回

Promise<WarrantBrief[]>（symbol / name / latestPrice / change / changeRate / volume / amount / underlying / issuer / expiryDate / strikePrice / warrantType）。

getWarrantFilter 窝轮筛选

qc.getWarrantFilter(req: WarrantFilterRequest): Promise<WarrantFilterResult | undefined>

请求 WarrantFilterRequest

返回

Promise<WarrantFilterResult | undefined>（total / items / pageSize / page）。

行业

getIndustryList 获取行业列表

qc.getIndustryList(req: IndustryListRequest): Promise<IndustryItem[]>

请求 IndustryListRequest：industryLevel / lang。

返回

Promise<IndustryItem[]>（id / name / level）。

getIndustryStocks 获取行业下股票

qc.getIndustryStocks(req: IndustryStocksRequest): Promise<IndustryStock[]>

请求 IndustryStocksRequest：industryId / market / lang。

返回

Promise<IndustryStock[]>（symbol / name / industryId / change / changeRate）。

选股器

marketScanner 选股器

qc.marketScanner(req: MarketScannerRequest): Promise<ScannerResult | undefined>

说明

根据自定义条件筛选股票。

请求 MarketScannerRequest

返回

Promise<ScannerResult | undefined>，对象含 page、totalPage、totalCount、pageSize、cursorId，以及 items: ScannerResultItem[]（每项含 symbol、market 及分类数据列表）。

示例

const res = await qc.marketScanner({ market: 'US', page: 0, pageSize: 10 });
console.log(`page=${res?.page}/${res?.totalPage} items=${res?.items.length}`);

getMarketScannerTags 获取选股扫描器标签

qc.getMarketScannerTags(req: MarketScannerTagsRequest): Promise<MarketScannerTagGroup[] | undefined>

说明

查询选股扫描器（marketScanner）可用的 multi_tags 字段及枚举值。

请求 MarketScannerTagsRequest

返回

Promise<MarketScannerTagGroup[] | undefined>，每个 MarketScannerTagGroup 含：

示例

const groups = await qc.getMarketScannerTags({ market: 'US', multiTagFieldList: ['sector'] });
console.log(groups?.length, groups?.[0]?.multiTagField, groups?.[0]?.tagList.length);