证券

示例上下文

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

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

获取股票代码列表

签名

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

用途

查询 symbols。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqSymbolsRequestNone
req.marketstring | undefined
req.secTypestring | undefined
req.includeOtcboolean | undefined
req.langstring | undefined

返回

Promise<string[]>

示例

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

返回示例

[
  "string"
]

获取股票代码和名称列表

签名

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

用途

查询 symbol names。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqSymbolsRequestNone
req.marketstring | undefined
req.secTypestring | undefined
req.includeOtcboolean | undefined
req.langstring | undefined

返回

Promise<SymbolName[]>

字段类型说明
symbolstring股票代码
namestring名称
marketstring市场

示例

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

返回示例

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

获取交易元数据

签名

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

用途

查询 trade metas。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqTradeMetasRequestNone
req.symbolsstring[] | undefined
req.langstring | undefined

返回

Promise<TradeMeta[]>

字段类型说明
symbolstring股票代码
lotSizenumber每手股数
minTicknumber最小变动单位
spreadScalenumber报价精度
shortableFlagstring可做空标记
marginableFlagstring可融资标记

示例

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[]>

用途

查询 real time quote。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqBriefRequestNone
req.symbolsstring[] | undefined
req.includeHourTradingboolean | undefined
req.secTypestring | undefined
req.langstring | undefined

返回

Promise<Brief[]>

字段类型说明
symbolstring股票代码
opennumber开盘价
highnumber最高价
lownumber最低价
closenumber收盘价
preClosenumber前收价
latestPricenumber最新价
latestTimenumber最新成交时间(毫秒时间戳)
askPricenumber卖一价
askSizenumber卖一量
bidPricenumber买一价
bidSizenumber买一量
volumenumber成交量
statusstring交易状态
adjPreClosenumber复权前收价
changenumber涨跌额
changeRatenumber涨跌幅
amplitudenumber振幅
expirystring到期日
strikestring行权价
rightstring期权方向
multipliernumber合约乘数
openInterestnumber未平仓量

示例

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[]>

用途

查询 delayed quote。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqStockDelayBriefsRequestNone
req.symbolsstring[] | undefined
req.secTypestring | undefined
req.langstring | undefined

返回

Promise<Brief[]>

字段类型说明
symbolstring股票代码
opennumber开盘价
highnumber最高价
lownumber最低价
closenumber收盘价
preClosenumber前收价
latestPricenumber最新价
latestTimenumber最新成交时间(毫秒时间戳)
askPricenumber卖一价
askSizenumber卖一量
bidPricenumber买一价
bidSizenumber买一量
volumenumber成交量
statusstring交易状态
adjPreClosenumber复权前收价
changenumber涨跌额
changeRatenumber涨跌幅
amplitudenumber振幅
expirystring到期日
strikestring行权价
rightstring期权方向
multipliernumber合约乘数
openInterestnumber未平仓量

示例

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
  }
]

获取 K 线数据

签名

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

用途

查询 kline。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqKlineRequestNone
req.symbolsstring[] | undefined
req.periodstring | undefined
req.rightstring | undefined
req.beginTimenumber | undefined
req.endTimenumber | undefined
req.limitnumber | undefined
req.beginIndexnumber | undefined
req.endIndexnumber | undefined
req.pageTokenstring | undefined
req.tradeSessionstring | undefined
req.datestring | undefined
req.withFundamentalboolean | undefined
req.secTypestring | undefined
req.langstring | undefined

返回

Promise<Kline[]>

字段类型说明
symbolstring股票代码
periodstringK 线周期
nextPageTokenstring下一页 token
itemsKlineItem[]数据数组

示例

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

返回示例

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

分页获取 K 线数据

签名

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

用途

查询 kline by page。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqKlineByPageRequestNone
req.symbolstring | undefined
req.periodstring | undefined
req.beginTimenumber | undefined
req.endTimenumber | undefined
req.totalSizenumber | undefined1000 (client)
req.pageSizenumber | undefined200 (client)
req.rightstring | undefined
req.langstring | undefined
req.tradeSessionstring | undefined

返回

Promise<KlineItem[]>

字段类型说明
timenumber时间(毫秒时间戳)
volumenumber成交量
opennumber开盘价
closenumber收盘价
highnumber最高价
lownumber最低价
amountnumber成交额

示例

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[]>

用途

查询 timeline。

参数、默认值与约束

参数类型必填SDK 默认值约束
symbolsstring[]None

返回

Promise<Timeline[]>

字段类型说明
symbolstring股票代码
periodstringK 线周期
preClosenumber前收价
intradayTimelineBucket盘中分时数据
preHoursTimelineBucket盘前分时数据
afterHoursTimelineBucket盘后分时数据

示例

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[]>

用途

查询 timeline history。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqTimelineHistoryRequestNone
req.symbolsstring[] | undefined
req.datestring | undefinedyyyy-MM-dd
req.rightstring | undefined
req.tradeSessionstring | undefined
req.langstring | undefined

返回

Promise<Timeline[]>

字段类型说明
symbolstring股票代码
periodstringK 线周期
preClosenumber前收价
intradayTimelineBucket盘中分时数据
preHoursTimelineBucket盘前分时数据
afterHoursTimelineBucket盘后分时数据

示例

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[]>

用途

查询 trade tick。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqTradeTickRequestNone
req.symbolsstring[] | undefined
req.beginIndexnumber | undefined
req.endIndexnumber | undefined
req.limitnumber | undefined
req.langstring | undefined

返回

Promise<TradeTick[]>

字段类型说明
symbolstring股票代码
beginIndexnumber起始索引
endIndexnumber结束索引
itemsTradeTickItem[]数据数组

示例

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[]>

用途

查询 quote depth。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqDepthQuoteRequestNone
req.symbolsstring[] | undefined
req.marketstring | undefined
req.tradeSessionstring | undefined
req.langstring | undefined

返回

Promise<Depth[]>

字段类型说明
symbolstring股票代码
asksDepthLevel[]卖方委托队列
bidsDepthLevel[]买方委托队列

示例

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>

用途

查询 stock broker。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqStockBrokerRequestNone
req.symbolstring | undefined
req.limitnumber | undefined
req.secTypestring | undefined
req.langstring | undefined

返回

Promise<StockBroker | undefined>

字段类型说明
symbolstring股票代码
levelAskListStockBrokerItem[]卖方经纪商队列
levelBidListStockBrokerItem[]买方经纪商队列

示例

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>

用途

查询 capital flow。

参数、默认值与约束

参数类型必填SDK 默认值约束
symbolstringNone
marketstringNone
periodstringNone

返回

Promise<CapitalFlow | undefined>

字段类型说明
symbolstring股票代码
periodstringK 线周期
itemsCapitalFlowItem[]数据数组

示例

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>

用途

查询 capital distribution。

参数、默认值与约束

参数类型必填SDK 默认值约束
symbolstringNone
marketstringNone

返回

Promise<CapitalDistribution | undefined>

字段类型说明
symbolstring股票代码
netInflownumber净流入
inAllnumber总流入
inBignumber大单流入
inMidnumber中单流入
inSmallnumber小单流入
outAllnumber总流出
outBignumber大单流出
outMidnumber中单流出
outSmallnumber小单流出

示例

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[]>

用途

查询 trade rank。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqTradeRankRequestNone
req.marketstring | undefined
req.langstring | undefined

返回

Promise<TradeRankItem[]>

字段类型说明
symbolstring股票代码
namestring名称
latestPricenumber最新价
changenumber涨跌额
changeRatenumber涨跌幅
volumenumber成交量
amountnumber成交额

示例

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[]>

用途

查询 short interest。

参数、默认值与约束

参数类型必填SDK 默认值约束
reqShortInterestRequestNone
req.symbolsstring[] | undefined
req.langstring | undefined

返回

Promise<ShortInterest[]>

字段类型说明
symbolstring股票代码
settlementDatestring结算日期
shortInterestnumber做空股数
avgDailyVolumenumber日均成交量
daysToCovernumber回补天数
percentOfFloatnumber做空比例(%)
shortInterestPreviousnumber上期做空股数
percentChangenumber变动百分比

示例

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
  }
]

Did this page help you?