证券
示例上下文
import { createClientConfig, QuoteClient } from '@tigeropenapi/tigeropen';
const config = createClientConfig();
const quoteClient = QuoteClient.fromConfig(config);获取股票代码列表
签名
async getSymbols(req: SymbolsRequest): Promise<string[]>用途
查询 symbols。
参数、默认值与约束
| 参数 | 类型 | 必填 | SDK 默认值 | 约束 |
|---|---|---|---|---|
req | SymbolsRequest | 是 | None | — |
req.market | string | undefined | 否 | 无 | — |
req.secType | string | undefined | 否 | 无 | — |
req.includeOtc | boolean | undefined | 否 | 无 | — |
req.lang | string | 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 默认值 | 约束 |
|---|---|---|---|---|
req | SymbolsRequest | 是 | None | — |
req.market | string | undefined | 否 | 无 | — |
req.secType | string | undefined | 否 | 无 | — |
req.includeOtc | boolean | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<SymbolName[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| name | string | 名称 |
| market | string | 市场 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | TradeMetasRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<TradeMeta[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| lotSize | number | 每手股数 |
| minTick | number | 最小变动单位 |
| spreadScale | number | 报价精度 |
| shortableFlag | string | 可做空标记 |
| marginableFlag | string | 可融资标记 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | BriefRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.includeHourTrading | boolean | undefined | 否 | 无 | — |
req.secType | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<Brief[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| open | number | 开盘价 |
| high | number | 最高价 |
| low | number | 最低价 |
| close | number | 收盘价 |
| preClose | number | 前收价 |
| latestPrice | number | 最新价 |
| latestTime | number | 最新成交时间(毫秒时间戳) |
| askPrice | number | 卖一价 |
| askSize | number | 卖一量 |
| bidPrice | number | 买一价 |
| bidSize | number | 买一量 |
| volume | number | 成交量 |
| status | string | 交易状态 |
| adjPreClose | number | 复权前收价 |
| change | number | 涨跌额 |
| changeRate | number | 涨跌幅 |
| amplitude | number | 振幅 |
| expiry | string | 到期日 |
| strike | string | 行权价 |
| right | string | 期权方向 |
| multiplier | number | 合约乘数 |
| openInterest | number | 未平仓量 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | StockDelayBriefsRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.secType | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<Brief[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| open | number | 开盘价 |
| high | number | 最高价 |
| low | number | 最低价 |
| close | number | 收盘价 |
| preClose | number | 前收价 |
| latestPrice | number | 最新价 |
| latestTime | number | 最新成交时间(毫秒时间戳) |
| askPrice | number | 卖一价 |
| askSize | number | 卖一量 |
| bidPrice | number | 买一价 |
| bidSize | number | 买一量 |
| volume | number | 成交量 |
| status | string | 交易状态 |
| adjPreClose | number | 复权前收价 |
| change | number | 涨跌额 |
| changeRate | number | 涨跌幅 |
| amplitude | number | 振幅 |
| expiry | string | 到期日 |
| strike | string | 行权价 |
| right | string | 期权方向 |
| multiplier | number | 合约乘数 |
| openInterest | number | 未平仓量 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | KlineRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.period | string | undefined | 否 | 无 | — |
req.right | string | undefined | 否 | 无 | — |
req.beginTime | number | undefined | 否 | 无 | — |
req.endTime | number | undefined | 否 | 无 | — |
req.limit | number | undefined | 否 | 无 | — |
req.beginIndex | number | undefined | 否 | 无 | — |
req.endIndex | number | undefined | 否 | 无 | — |
req.pageToken | string | undefined | 否 | 无 | — |
req.tradeSession | string | undefined | 否 | 无 | — |
req.date | string | undefined | 否 | 无 | — |
req.withFundamental | boolean | undefined | 否 | 无 | — |
req.secType | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<Kline[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| period | string | K 线周期 |
| nextPageToken | string | 下一页 token |
| items | KlineItem[] | 数据数组 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | KlineByPageRequest | 是 | None | — |
req.symbol | string | undefined | 否 | 无 | — |
req.period | string | undefined | 否 | 无 | — |
req.beginTime | number | undefined | 否 | 无 | — |
req.endTime | number | undefined | 否 | 无 | — |
req.totalSize | number | undefined | 否 | 1000 (client) | — |
req.pageSize | number | undefined | 否 | 200 (client) | — |
req.right | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
req.tradeSession | string | undefined | 否 | 无 | — |
返回
Promise<KlineItem[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| time | number | 时间(毫秒时间戳) |
| volume | number | 成交量 |
| open | number | 开盘价 |
| close | number | 收盘价 |
| high | number | 最高价 |
| low | number | 最低价 |
| amount | number | 成交额 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
symbols | string[] | 是 | None | — |
返回
Promise<Timeline[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| period | string | K 线周期 |
| preClose | number | 前收价 |
| intraday | TimelineBucket | 盘中分时数据 |
| preHours | TimelineBucket | 盘前分时数据 |
| afterHours | TimelineBucket | 盘后分时数据 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | TimelineHistoryRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.date | string | undefined | 否 | 无 | yyyy-MM-dd |
req.right | string | undefined | 否 | 无 | — |
req.tradeSession | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<Timeline[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| period | string | K 线周期 |
| preClose | number | 前收价 |
| intraday | TimelineBucket | 盘中分时数据 |
| preHours | TimelineBucket | 盘前分时数据 |
| afterHours | TimelineBucket | 盘后分时数据 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | TradeTickRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.beginIndex | number | undefined | 否 | 无 | — |
req.endIndex | number | undefined | 否 | 无 | — |
req.limit | number | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<TradeTick[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| beginIndex | number | 起始索引 |
| endIndex | number | 结束索引 |
| items | TradeTickItem[] | 数据数组 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | DepthQuoteRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.market | string | undefined | 否 | 无 | — |
req.tradeSession | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<Depth[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| asks | DepthLevel[] | 卖方委托队列 |
| bids | DepthLevel[] | 买方委托队列 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | StockBrokerRequest | 是 | None | — |
req.symbol | string | undefined | 否 | 无 | — |
req.limit | number | undefined | 否 | 无 | — |
req.secType | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<StockBroker | undefined>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| levelAskList | StockBrokerItem[] | 卖方经纪商队列 |
| levelBidList | StockBrokerItem[] | 买方经纪商队列 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
symbol | string | 是 | None | — |
market | string | 是 | None | — |
period | string | 是 | None | — |
返回
Promise<CapitalFlow | undefined>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| period | string | K 线周期 |
| items | CapitalFlowItem[] | 数据数组 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
symbol | string | 是 | None | — |
market | string | 是 | None | — |
返回
Promise<CapitalDistribution | undefined>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| netInflow | number | 净流入 |
| inAll | number | 总流入 |
| inBig | number | 大单流入 |
| inMid | number | 中单流入 |
| inSmall | number | 小单流入 |
| outAll | number | 总流出 |
| outBig | number | 大单流出 |
| outMid | number | 中单流出 |
| outSmall | number | 小单流出 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | TradeRankRequest | 是 | None | — |
req.market | string | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<TradeRankItem[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| name | string | 名称 |
| latestPrice | number | 最新价 |
| change | number | 涨跌额 |
| changeRate | number | 涨跌幅 |
| volume | number | 成交量 |
| amount | number | 成交额 |
示例
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 默认值 | 约束 |
|---|---|---|---|---|
req | ShortInterestRequest | 是 | None | — |
req.symbols | string[] | undefined | 否 | 无 | — |
req.lang | string | undefined | 否 | 无 | — |
返回
Promise<ShortInterest[]>
| 字段 | 类型 | 说明 |
|---|---|---|
| symbol | string | 股票代码 |
| settlementDate | string | 结算日期 |
| shortInterest | number | 做空股数 |
| avgDailyVolume | number | 日均成交量 |
| daysToCover | number | 回补天数 |
| percentOfFloat | number | 做空比例(%) |
| shortInterestPrevious | number | 上期做空股数 |
| percentChange | number | 变动百分比 |
示例
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
}
]Updated 8 days ago
