Cryptocurrency

Example context

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

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

`getKline`

Signature

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

Purpose

Gets cryptocurrency candlestick bars (K-line data) with secType: 'CC'.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty; at most 50 symbols
`req.period`	`string \| undefined`	No	None	None.
`req.right`	`string \| undefined`	No	None	Adjustment type.
`req.beginTime`	`number \| undefined`	No	None	None.
`req.endTime`	`number \| undefined`	No	None	None.
`req.limit`	`number \| undefined`	No	None	Omission or a non-positive value returns 300 bars; maximum 1,200
`req.beginIndex`	`number \| undefined`	No	None	Cannot be combined with `beginTime` or `endTime`.
`req.endIndex`	`number \| undefined`	No	None	Cannot be combined with `beginTime` or `endTime`.
`req.pageToken`	`string \| undefined`	No	None	Pagination cursor.
`req.tradeSession`	`string \| undefined`	No	None	Trading session.
`req.date`	`string \| undefined`	No	None	Date.
`req.withFundamental`	`boolean \| undefined`	No	None	Whether to include fundamental data.
`req.secType`	`string \| undefined`	Yes	None	Use `'CC'`.
`req.lang`	`string \| undefined`	No	None	Language.

Returns

Promise<Kline[]>

Each Kline:

Field	Type	Description
`symbol`	`string`	Cryptocurrency symbol
`period`	`string \| undefined`	Bar period
`nextPageToken`	`string \| undefined`	Next-page cursor
`items`	`KlineItem[]`	Bars

Each items element (KlineItem):

Field	Type	Description
`time`	`number`	Bar timestamp in milliseconds
`volume`	`number`	Integer volume; use when `volumeDecimal` is absent or `null`
`volumeDecimal`	`number \| null \| undefined`	Optional fractional cryptocurrency volume
`open`	`number`	Open price
`close`	`number`	Close price
`high`	`number`	High price
`low`	`number`	Low price
`amount`	`number \| undefined`	Turnover amount

Type-checked example

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);

Rate limit: The base limit is 60 requests per minute.

`getKlineByPage`

Signature

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

Purpose

Gets cryptocurrency bars through client-side pagination with secType: 'CC'.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req.symbol`	`string \| undefined`	Yes	None	None.
`req.secType`	`string \| undefined`	Yes	None	Use `'CC'`.
`req.period`	`string \| undefined`	No	None	None.
`req.beginTime`	`number \| undefined`	No	None	None.
`req.endTime`	`number \| undefined`	No	None	None.
`req.totalSize`	`number \| undefined`	No	1000	None.
`req.pageSize`	`number \| undefined`	No	200	None.
`req.right`	`string \| undefined`	No	None	Adjustment type.
`req.lang`	`string \| undefined`	No	None	Language.
`req.tradeSession`	`string \| undefined`	No	None	Trading session.

Returns

Promise<KlineItem[]>

Each returned KlineItem:

Field	Type	Description
`time`	`number`	Bar timestamp in milliseconds
`volume`	`number`	Integer volume; use when `volumeDecimal` is absent or `null`
`volumeDecimal`	`number \| null \| undefined`	Optional fractional cryptocurrency volume
`open`	`number`	Open price
`close`	`number`	Close price
`high`	`number`	High price
`low`	`number`	Low price
`amount`	`number \| undefined`	Turnover amount

Type-checked example

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);

Rate limit: The base limit is 60 requests per minute.

`getTimeline`

Signature

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

Purpose

Gets the current cryptocurrency timeline with secType: 'CC'.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty; at most 50 symbols
`req.secType`	`string \| undefined`	Yes	None	Use `'CC'`.

Returns

Promise<Timeline[]>

Each Timeline:

Field	Type	Description
`symbol`	`string`	Cryptocurrency symbol
`period`	`string`	Timeline period
`preClose`	`number`	Previous close
`intraday`	`TimelineBucket \| undefined`	Optional intraday bucket
`preHours`	`TimelineBucket \| undefined`	Optional pre-market bucket
`afterHours`	`TimelineBucket \| undefined`	Optional after-hours bucket

Each TimelineBucket:

Field	Type	Description
`items`	`TimelineItem[]`	Timeline points

Each items element (TimelineItem):

Field	Type	Description
`time`	`number`	Point timestamp in milliseconds
`volume`	`number`	Integer volume; use when `volumeDecimal` is absent or `null`
`volumeDecimal`	`number \| null \| undefined`	Optional fractional cryptocurrency volume
`price`	`number`	Price
`avgPrice`	`number`	Average price

Type-checked example

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

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

Rate limit: The base limit is 120 requests per minute.