通用

示例上下文

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

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

从配置创建

签名

static fromConfig(config: ClientConfig): QuoteClient

用途

从 ClientConfig 创建客户端。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`config`	`ClientConfig`	是	None	—
`config.tigerId`	`string`	是	无	—
`config.privateKey`	`string`	是	无	—
`config.account`	`string`	是	无	—
`config.secretKey`	`string \| undefined`	否	无	Institution secret key for trade authentication (institution accounts only)
`config.license`	`string \| undefined`	否	无	—
`config.language`	`string`	是	无	—
`config.timezone`	`string \| undefined`	否	无	—
`config.timeout`	`number`	是	无	—
`config.token`	`string \| undefined`	否	无	—
`config.tokenRefreshDuration`	`number \| undefined`	否	无	—
`config.tokenCheckInterval`	`number \| undefined`	否	无	后台 token 检查间隔（毫秒），仅 tokenRefreshDuration > 0 时生效，默认 5 分钟
`config.tokenLoader`	返回字符串或字符串 Promise 的可选函数	否	无	自定义 token 加载函数，替代默认的文件加载；精确类型见上方签名引用的 `ClientConfig`
`config.tokenWriter`	`((token: string) => void) \| undefined`	否	无	token 刷新写入后的可选回调
`config.serverUrl`	`string`	是	无	—
`config.quoteServerUrl`	`string`	是	无	Quote server URL for quote-specific requests; falls back to serverUrl
`config.deviceId`	`string`	是	无	Device identifier (auto-detected MAC address)
`config.tigerPublicKey`	`string`	是	无	—

QuoteClient

示例

const result = await QuoteClient.fromConfig(config);
console.log(result);

返回示例

"QuoteClient instance (not an API response payload)"

获取市场状态

签名

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

用途

查询 market state。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`market`	`string`	是	None	—

Promise<MarketState[]>

字段	类型	说明
market	string	市场
marketStatus	string	市场状态
status	string	交易状态
openTime	string	开盘时间

示例

const result = await quoteClient.getMarketState('US');
console.log(result);

返回示例

[
  {
    "market": "string",
    "marketStatus": "string",
    "status": "string",
    "openTime": "string"
  }
]

获取交易日历

签名

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

用途

查询 trading calendar。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`req`	`TradingCalendarRequest`	是	None	—
`req.market`	`string \| undefined`	否	无	—
`req.beginDate`	`string \| undefined`	否	无	yyyy-MM-dd
`req.endDate`	`string \| undefined`	否	无	—
`req.lang`	`string \| undefined`	否	无	—

Promise<TradingCalendarItem[]>

字段	类型	说明
market	string	市场
date	string	日期
isTrading	boolean	是否交易日
sessionType	string	交易时段类型

示例

const result = await quoteClient.getTradingCalendar({ market: 'US', beginDate: '2026-01-01', endDate: '2026-01-31' });
console.log(result);

返回示例

[
  {
    "market": "string",
    "date": "string",
    "isTrading": "boolean",
    "sessionType": "string"
  }
]

抢占行情权限

签名

async grabQuotePermission(): Promise<QuotePermission[]>

用途

请求将当前 Tiger ID 的行情访问切换到本设备。

参数、默认值与约束

无参数。

Promise<QuotePermission[]>

字段	类型	说明
name	string	名称
expireAt	number	过期时间戳

示例

const result = await quoteClient.grabQuotePermission();
console.log(result);

返回示例

[
  {
    "name": "string",
    "expireAt": 0
  }
]

获取行情权限

签名

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

用途

查询 quote permission。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`req`	`QuotePermissionRequest`	是	None	—
`req.beginDate`	`string \| undefined`	否	无	—
`req.endDate`	`string \| undefined`	否	无	—
`req.lang`	`string \| undefined`	否	无	—

Promise<QuotePermission[]>

字段	类型	说明
name	string	名称
expireAt	number	过期时间戳

示例

const result = await quoteClient.getQuotePermission({ beginDate: '20260101', endDate: '20260131' });
console.log(result);

返回示例

[
  {
    "name": "string",
    "expireAt": 0
  }
]

获取 K 线额度

签名

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

用途

查询 kline quota。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`req`	`KlineQuotaRequest`	是	None	—
`req.withDetails`	`boolean \| undefined`	否	无	—
`req.lang`	`string \| undefined`	否	无	—

Promise<KlineQuota[]>

字段	类型	说明
method	string	接口方法
used	number	已使用
quota	number	配额
detail	KlineQuotaDetail[]	详细配额

示例

const result = await quoteClient.getKlineQuota({ withDetails: true });
console.log(result);

返回示例

[
  {
    "method": "string",
    "used": 0,
    "quota": 0,
    "detail": [
      "KlineQuotaDetail"
    ]
  }
]