数字货币

示例上下文

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

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

获取数字货币 K 线数据

签名

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

用途

设置 secType: 'CC' 查询数字货币 K 线。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`req.symbols`	`string[] \| undefined`	是	无	非空，最多 50 个标的代码
`req.period`	`string \| undefined`	否	无	—
`req.right`	`string \| undefined`	否	无	复权类型
`req.beginTime`	`number \| undefined`	否	无	—
`req.endTime`	`number \| undefined`	否	无	—
`req.limit`	`number \| undefined`	否	无	省略或不大于 0 时返回 300 条；最大 1,200
`req.beginIndex`	`number \| undefined`	否	无	不可与 `beginTime` 或 `endTime` 同时使用
`req.endIndex`	`number \| undefined`	否	无	不可与 `beginTime` 或 `endTime` 同时使用
`req.pageToken`	`string \| undefined`	否	无	分页游标
`req.tradeSession`	`string \| undefined`	否	无	交易时段
`req.date`	`string \| undefined`	否	无	日期
`req.withFundamental`	`boolean \| undefined`	否	无	是否附带基本面数据
`req.secType`	`string \| undefined`	是	无	传 `'CC'`
`req.lang`	`string \| undefined`	否	无	语言

Promise<Kline[]>

每个 Kline：

字段	类型	说明
`symbol`	`string`	数字货币代码
`period`	`string \| undefined`	K 线周期
`nextPageToken`	`string \| undefined`	下一页游标
`items`	`KlineItem[]`	K 线数据

每个 items 元素（KlineItem）：

字段	类型	说明
`time`	`number`	K 线毫秒时间戳
`volume`	`number`	整数成交量；`volumeDecimal` 缺失或为 `null` 时使用
`volumeDecimal`	`number \| null \| undefined`	可选小数数字货币成交量
`open`	`number`	开盘价
`close`	`number`	收盘价
`high`	`number`	最高价
`low`	`number`	最低价
`amount`	`number \| undefined`	成交额

示例

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

const quoteClient = QuoteClient.fromConfig(createClientConfig());
const result = await quoteClient.getKline({
  symbols: ['BTC.USD'],
  secType: 'CC',
  period: 'day',
  limit: 100,
});
console.log(result);

请求频率：基础上限为每分钟 60 次。

分页获取数字货币 K 线数据

签名

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

用途

设置 secType: 'CC' 通过客户端分页查询数字货币 K 线。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`req.symbol`	`string \| undefined`	是	无	—
`req.secType`	`string \| undefined`	是	无	传 `'CC'`
`req.period`	`string \| undefined`	否	无	—
`req.beginTime`	`number \| undefined`	否	无	—
`req.endTime`	`number \| undefined`	否	无	—
`req.totalSize`	`number \| undefined`	否	1000	—
`req.pageSize`	`number \| undefined`	否	200	—
`req.right`	`string \| undefined`	否	无	复权类型
`req.lang`	`string \| undefined`	否	无	语言
`req.tradeSession`	`string \| undefined`	否	无	交易时段

Promise<KlineItem[]>

每个返回的 KlineItem：

字段	类型	说明
`time`	`number`	K 线毫秒时间戳
`volume`	`number`	整数成交量；`volumeDecimal` 缺失或为 `null` 时使用
`volumeDecimal`	`number \| null \| undefined`	可选小数数字货币成交量
`open`	`number`	开盘价
`close`	`number`	收盘价
`high`	`number`	最高价
`low`	`number`	最低价
`amount`	`number \| undefined`	成交额

示例

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

const quoteClient = QuoteClient.fromConfig(createClientConfig());
const result = await quoteClient.getKlineByPage({
  symbol: 'BTC.USD',
  secType: 'CC',
  period: 'day',
  totalSize: 500,
  pageSize: 200,
});
console.log(result);

请求频率：基础上限为每分钟 60 次。

获取数字货币当前分时数据

签名

async getTimeline(req: TimelineRequest): Promise<Timeline[]>

用途

设置 secType: 'CC' 查询数字货币当前分时数据。

参数、默认值与约束

参数	类型	必填	SDK 默认值	约束
`req.symbols`	`string[] \| undefined`	是	无	非空，最多 50 个标的代码
`req.secType`	`string \| undefined`	是	无	传 `'CC'`

Promise<Timeline[]>

每个 Timeline：

字段	类型	说明
`symbol`	`string`	数字货币代码
`period`	`string`	分时周期
`preClose`	`number`	前收价
`intraday`	`TimelineBucket \| undefined`	可选盘中分时数据块
`preHours`	`TimelineBucket \| undefined`	可选盘前分时数据块
`afterHours`	`TimelineBucket \| undefined`	可选盘后分时数据块

每个 TimelineBucket：

字段	类型	说明
`items`	`TimelineItem[]`	分时点

每个 items 元素（TimelineItem）：

字段	类型	说明
`time`	`number`	分时点毫秒时间戳
`volume`	`number`	整数成交量；`volumeDecimal` 缺失或为 `null` 时使用
`volumeDecimal`	`number \| null \| undefined`	可选小数数字货币成交量
`price`	`number`	价格
`avgPrice`	`number`	均价

示例

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

const quoteClient = QuoteClient.fromConfig(createClientConfig());
const result = await quoteClient.getTimeline({
  symbols: ['BTC.USD'],
  secType: 'CC',
});
console.log(result);

请求频率：基础上限为每分钟 120 次。