Futures

Example context

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

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

`getFutureExchange`

Signature

async getFutureExchange(): Promise<FutureExchange[]>

Purpose

Gets future exchange.

Parameters, defaults, and constraints

No parameters.

Returns

Promise<FutureExchange[]>

Field	Type	Description
code	string	Exchange code
name	string	Name
zoneId	string	Time zone ID

Type-checked example

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

Response example

[
  {
    "code": "string",
    "name": "string",
    "zoneId": "string"
  }
]

`getFutureContracts`

Signature

async getFutureContracts(exchange: string): Promise<FutureContractInfo[]>

Purpose

Gets future contracts.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`exchange`	`string`	Yes	None	No client-side validation is declared.

Returns

Promise<FutureContractInfo[]>

Field	Type	Description
continuous	boolean	Whether continuous contract
trade	boolean	Whether tradable
type	string	Contract type
contractCode	string	Contract code
ibCode	string	IB code
name	string	Name
contractMonth	string	Contract month
lastTradingDate	string	Last trading date
firstNoticeDate	string	First notice date
lastBiddingCloseTime	number	Last bidding close time
currency	string	Currency
exchangeCode	string	Exchange code
multiplier	number	Contract multiplier
minTick	number	Minimum tick size
displayMultiplier	number	Display multiplier
exchange	string	Exchange
productWorth	string	Contract value
deliveryMode	string	Delivery mode
productType	string	Product type
productScale	string	Product scale
lastTradingTimestamp	number	Last trading timestamp

Type-checked example

const result = await quoteClient.getFutureContracts('CME');
console.log(result);

Response example

[
  {
    "continuous": true,
    "trade": true,
    "type": "string",
    "contractCode": "string",
    "ibCode": "string",
    "name": "string",
    "contractMonth": "string",
    "lastTradingDate": "string",
    "firstNoticeDate": "string",
    "lastBiddingCloseTime": 0,
    "currency": "string",
    "exchangeCode": "string",
    "multiplier": 0,
    "minTick": 0,
    "displayMultiplier": 0,
    "exchange": "string",
    "productWorth": "string",
    "deliveryMode": "string",
    "productType": "string",
    "productScale": "string",
    "lastTradingTimestamp": 0
  }
]

`getFutureContract`

Signature

async getFutureContract(req: FutureContractSingleRequest): Promise<FutureContractInfo[]>

Purpose

Gets future contract.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureContractSingleRequest`	Yes	None	No client-side validation is declared.
`req.contractCode`	`string \| undefined`	No	None	No client-side validation is declared.
`req.type`	`string \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureContractInfo[]>

Field	Type	Description
continuous	boolean	Whether continuous contract
trade	boolean	Whether tradable
type	string	Contract type
contractCode	string	Contract code
ibCode	string	IB code
name	string	Name
contractMonth	string	Contract month
lastTradingDate	string	Last trading date
firstNoticeDate	string	First notice date
lastBiddingCloseTime	number	Last bidding close time
currency	string	Currency
exchangeCode	string	Exchange code
multiplier	number	Contract multiplier
minTick	number	Minimum tick size
displayMultiplier	number	Display multiplier
exchange	string	Exchange
productWorth	string	Contract value
deliveryMode	string	Delivery mode
productType	string	Product type
productScale	string	Product scale
lastTradingTimestamp	number	Last trading timestamp

Type-checked example

const result = await quoteClient.getFutureContract({ contractCode: 'MEUR2609' });
console.log(result);

Response example

[
  {
    "continuous": true,
    "trade": true,
    "type": "string",
    "contractCode": "string",
    "ibCode": "string",
    "name": "string",
    "contractMonth": "string",
    "lastTradingDate": "string",
    "firstNoticeDate": "string",
    "lastBiddingCloseTime": 0,
    "currency": "string",
    "exchangeCode": "string",
    "multiplier": 0,
    "minTick": 0,
    "displayMultiplier": 0,
    "exchange": "string",
    "productWorth": "string",
    "deliveryMode": "string",
    "productType": "string",
    "productScale": "string",
    "lastTradingTimestamp": 0
  }
]

`getAllFutureContracts`

Signature

async getAllFutureContracts(req: AllFutureContractsRequest): Promise<FutureContractInfo[]>

Purpose

Gets all future contracts.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`AllFutureContractsRequest`	Yes	None	No client-side validation is declared.
`req.type`	`string \| undefined`	No	None	No client-side validation is declared.
`req.exchange`	`string \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureContractInfo[]>

Field	Type	Description
continuous	boolean	Whether continuous contract
trade	boolean	Whether tradable
type	string	Contract type
contractCode	string	Contract code
ibCode	string	IB code
name	string	Name
contractMonth	string	Contract month
lastTradingDate	string	Last trading date
firstNoticeDate	string	First notice date
lastBiddingCloseTime	number	Last bidding close time
currency	string	Currency
exchangeCode	string	Exchange code
multiplier	number	Contract multiplier
minTick	number	Minimum tick size
displayMultiplier	number	Display multiplier
exchange	string	Exchange
productWorth	string	Contract value
deliveryMode	string	Delivery mode
productType	string	Product type
productScale	string	Product scale
lastTradingTimestamp	number	Last trading timestamp

Type-checked example

const result = await quoteClient.getAllFutureContracts({ type: 'MEUR' });
console.log(result);

Response example

[
  {
    "continuous": true,
    "trade": true,
    "type": "string",
    "contractCode": "string",
    "ibCode": "string",
    "name": "string",
    "contractMonth": "string",
    "lastTradingDate": "string",
    "firstNoticeDate": "string",
    "lastBiddingCloseTime": 0,
    "currency": "string",
    "exchangeCode": "string",
    "multiplier": 0,
    "minTick": 0,
    "displayMultiplier": 0,
    "exchange": "string",
    "productWorth": "string",
    "deliveryMode": "string",
    "productType": "string",
    "productScale": "string",
    "lastTradingTimestamp": 0
  }
]

`getCurrentFutureContract`

Signature

async getCurrentFutureContract(req: FutureContractSingleRequest): Promise<FutureContractInfo | undefined>

Purpose

Gets current future contract.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureContractSingleRequest`	Yes	None	No client-side validation is declared.
`req.contractCode`	`string \| undefined`	No	None	No client-side validation is declared.
`req.type`	`string \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureContractInfo | undefined>

Field	Type	Description
continuous	boolean	Whether continuous contract
trade	boolean	Whether tradable
type	string	Contract type
contractCode	string	Contract code
ibCode	string	IB code
name	string	Name
contractMonth	string	Contract month
lastTradingDate	string	Last trading date
firstNoticeDate	string	First notice date
lastBiddingCloseTime	number	Last bidding close time
currency	string	Currency
exchangeCode	string	Exchange code
multiplier	number	Contract multiplier
minTick	number	Minimum tick size
displayMultiplier	number	Display multiplier
exchange	string	Exchange
productWorth	string	Contract value
deliveryMode	string	Delivery mode
productType	string	Product type
productScale	string	Product scale
lastTradingTimestamp	number	Last trading timestamp

Type-checked example

const result = await quoteClient.getCurrentFutureContract({ type: 'MEUR' });
console.log(result);

Response example

{
  "continuous": true,
  "trade": true,
  "type": "string",
  "contractCode": "string",
  "ibCode": "string",
  "name": "string",
  "contractMonth": "string",
  "lastTradingDate": "string",
  "firstNoticeDate": "string",
  "lastBiddingCloseTime": 0,
  "currency": "string",
  "exchangeCode": "string",
  "multiplier": 0,
  "minTick": 0,
  "displayMultiplier": 0,
  "exchange": "string",
  "productWorth": "string",
  "deliveryMode": "string",
  "productType": "string",
  "productScale": "string",
  "lastTradingTimestamp": 0
}

`getFutureContinuousContracts`

Signature

async getFutureContinuousContracts(req: FutureContinuousContractsRequest): Promise<FutureContractInfo[]>

Purpose

Gets future continuous contracts.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureContinuousContractsRequest`	Yes	None	No client-side validation is declared.
`req.type`	`string \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureContractInfo[]>

Field	Type	Description
continuous	boolean	Whether continuous contract
trade	boolean	Whether tradable
type	string	Contract type
contractCode	string	Contract code
ibCode	string	IB code
name	string	Name
contractMonth	string	Contract month
lastTradingDate	string	Last trading date
firstNoticeDate	string	First notice date
lastBiddingCloseTime	number	Last bidding close time
currency	string	Currency
exchangeCode	string	Exchange code
multiplier	number	Contract multiplier
minTick	number	Minimum tick size
displayMultiplier	number	Display multiplier
exchange	string	Exchange
productWorth	string	Contract value
deliveryMode	string	Delivery mode
productType	string	Product type
productScale	string	Product scale
lastTradingTimestamp	number	Last trading timestamp

Type-checked example

const result = await quoteClient.getFutureContinuousContracts({ type: 'MEUR' });
console.log(result);

Response example

[
  {
    "continuous": true,
    "trade": true,
    "type": "string",
    "contractCode": "string",
    "ibCode": "string",
    "name": "string",
    "contractMonth": "string",
    "lastTradingDate": "string",
    "firstNoticeDate": "string",
    "lastBiddingCloseTime": 0,
    "currency": "string",
    "exchangeCode": "string",
    "multiplier": 0,
    "minTick": 0,
    "displayMultiplier": 0,
    "exchange": "string",
    "productWorth": "string",
    "deliveryMode": "string",
    "productType": "string",
    "productScale": "string",
    "lastTradingTimestamp": 0
  }
]

`getFutureHistoryMainContract`

Signature

async getFutureHistoryMainContract(req: FutureHistoryMainContractRequest): Promise<FutureMainContractHistory[]>

Purpose

Gets future history main contract.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureHistoryMainContractRequest`	Yes	None	No client-side validation is declared.
`req.contractCodes`	`string[] \| undefined`	No	None	No client-side validation is declared.
`req.beginTime`	`number \| undefined`	No	None	No client-side validation is declared.
`req.endTime`	`number \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureMainContractHistory[]>

Field	Type	Description
contractCode	string	Contract code
symbol	string	Symbol code
beginDate	string	Begin date
endDate	string	End date

Type-checked example

const result = await quoteClient.getFutureHistoryMainContract({ contractCodes: ['MEUR2609'], beginTime: Date.UTC(2026, 0, 1), endTime: Date.UTC(2026, 6, 31) });
console.log(result);

Response example

[
  {
    "contractCode": "string",
    "symbol": "string",
    "beginDate": "string",
    "endDate": "string"
  }
]

`getFutureRealTimeQuote`

Signature

async getFutureRealTimeQuote(req: FutureBriefRequest): Promise<FutureQuote[]>

Purpose

Gets future real time quote.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureBriefRequest`	Yes	None	No client-side validation is declared.
`req.contractCodes`	`string[] \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureQuote[]>

Field	Type	Description
contractCode	string	Contract code
latestPrice	number	Latest price
latestSize	number	Latest trade size
latestTime	number	Latest trade time (ms timestamp)
bidPrice	number	Bid price (best bid)
askPrice	number	Ask price (best offer)
bidSize	number	Bid size
askSize	number	Ask size
openInterest	number	Open interest
openInterestChange	number	Open interest change
volume	number	Trading volume
open	number	Open price
high	number	High price
low	number	Low price
settlement	number	Settlement price
limitUp	number	Limit up price
limitDown	number	Limit down price
avgPrice	number	Average price

Type-checked example

const result = await quoteClient.getFutureRealTimeQuote({ contractCodes: ['MEUR2609'] });
console.log(result);

Response example

[
  {
    "contractCode": "string",
    "latestPrice": 0,
    "latestSize": 0,
    "latestTime": 0,
    "bidPrice": 0,
    "askPrice": 0,
    "bidSize": 0,
    "askSize": 0,
    "openInterest": 0,
    "openInterestChange": 0,
    "volume": 0,
    "open": 0,
    "high": 0,
    "low": 0,
    "settlement": 0,
    "limitUp": 0,
    "limitDown": 0,
    "avgPrice": 0
  }
]

`getFutureKline`

Signature

async getFutureKline(req: FutureKlineRequest): Promise<FutureKline[]>

Purpose

Gets future kline.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureKlineRequest`	Yes	None	No client-side validation is declared.
`req.contractCodes`	`string[] \| undefined`	No	None	No client-side validation is declared.
`req.contractCode`	`string \| undefined`	No	None	No client-side validation is declared.
`req.period`	`string \| undefined`	No	None	No client-side validation is declared.
`req.beginTime`	`number \| undefined`	No	-1 (client)	No client-side validation is declared.
`req.endTime`	`number \| undefined`	No	-1 (client)	No client-side validation is declared.
`req.beginIndex`	`number \| undefined`	No	None	No client-side validation is declared.
`req.endIndex`	`number \| undefined`	No	None	No client-side validation is declared.
`req.limit`	`number \| undefined`	No	None	No client-side validation is declared.
`req.pageToken`	`string \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureKline[]>

Field	Type	Description
nextPageToken	string	Next page token
items	FutureKlineItem[]	Data items array

Type-checked example

const result = await quoteClient.getFutureKline({ contractCodes: ['MEUR2609'], period: 'day', beginTime: -1, endTime: -1 });
console.log(result);

Response example

[
  {
    "nextPageToken": "string",
    "items": [
      "FutureKlineItem"
    ]
  }
]

`getFutureKlineByPage`

Signature

async getFutureKlineByPage(req: FutureKlineByPageRequest): Promise<FutureKlineItem[]>

Purpose

Gets future kline by page.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureKlineByPageRequest`	Yes	None	No client-side validation is declared.
`req.contractCode`	`string \| undefined`	No	None	No client-side validation is declared.
`req.period`	`string \| undefined`	No	None	No client-side validation is declared.
`req.beginTime`	`number \| undefined`	No	None	No client-side validation is declared.
`req.endTime`	`number \| undefined`	No	None	No client-side validation is declared.
`req.totalSize`	`number \| undefined`	No	1000 (client)	No client-side validation is declared.
`req.pageSize`	`number \| undefined`	No	200 (client)	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureKlineItem[]>

Field	Type	Description
time	number	Time (ms timestamp)
volume	number	Trading volume
open	number	Open price
close	number	Close price
high	number	High price
low	number	Low price
lastTime	number	Last time
openInterest	number	Open interest
settlement	number	Settlement price

Type-checked example

const result = await quoteClient.getFutureKlineByPage({ contractCode: 'MEUR2609', period: 'day', totalSize: 500, pageSize: 200 });
console.log(result);

Response example

[
  {
    "time": 0,
    "volume": 0,
    "open": 0,
    "close": 0,
    "high": 0,
    "low": 0,
    "lastTime": 0,
    "openInterest": 0,
    "settlement": 0
  }
]

`getFutureTradeTicks`

Signature

async getFutureTradeTicks(req: FutureTradeTicksRequest): Promise<FutureTradeTickItem[]>

Purpose

Gets future trade ticks.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureTradeTicksRequest`	Yes	None	No client-side validation is declared.
`req.contractCode`	`string \| undefined`	No	None	No client-side validation is declared.
`req.beginIndex`	`number \| undefined`	No	None	No client-side validation is declared.
`req.endIndex`	`number \| undefined`	No	30 when falsy (client)	No client-side validation is declared.
`req.limit`	`number \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureTradeTickItem[]>

Field	Type	Description
contractCode	string	Contract code
index	number	Index
time	number	Time (ms timestamp)
price	number	Price
volume	number	Trading volume
direction	string	Direction

Type-checked example

const result = await quoteClient.getFutureTradeTicks({ contractCode: 'MEUR2609', limit: 10 });
console.log(result);

Response example

[
  {
    "contractCode": "string",
    "index": 0,
    "time": 0,
    "price": 0,
    "volume": 0,
    "direction": "string"
  }
]

`getFutureDepth`

Signature

async getFutureDepth(req: FutureDepthRequest): Promise<FutureDepth[]>

Purpose

Gets future depth.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureDepthRequest`	Yes	None	No client-side validation is declared.
`req.contractCodes`	`string[] \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureDepth[]>

Field	Type	Description
contractCode	string	Contract code
timestamp	number	Timestamp
asks	DepthLevel[]	Ask order queue
bids	DepthLevel[]	Bid order queue

Type-checked example

const result = await quoteClient.getFutureDepth({ contractCodes: ['MEUR2609'] });
console.log(result);

Response example

[
  {
    "contractCode": "string",
    "timestamp": 0,
    "asks": [
      "DepthLevel"
    ],
    "bids": [
      "DepthLevel"
    ]
  }
]

`getFutureTradingTimes`

Signature

async getFutureTradingTimes(req: FutureTradingTimesRequest): Promise<FutureTradingTime | undefined>

Purpose

Gets future trading times.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FutureTradingTimesRequest`	Yes	None	No client-side validation is declared.
`req.contractCode`	`string \| undefined`	No	None	No client-side validation is declared.
`req.tradingDate`	`string \| undefined`	No	None	No client-side validation is declared.
`req.lang`	`string \| undefined`	No	None	No client-side validation is declared.

Returns

Promise<FutureTradingTime | undefined>

Field	Type	Description
contractCode	string	Contract code
bizDate	string	Business date
zone	string	Time zone
tradingTimes	FutureTradingSegment[]	Trading times list

Type-checked example

const result = await quoteClient.getFutureTradingTimes({ contractCode: 'MEUR2609', tradingDate: '2026-07-24' });
console.log(result);

Response example

{
  "contractCode": "string",
  "bizDate": "string",
  "zone": "string",
  "tradingTimes": [
    {
      "start": 0,
      "end": 0,
      "type": "string"
    }
  ]
}