Fund and Warrants

Example context

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

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

`getFundSymbols`

Signature

async getFundSymbols(req: FundSymbolsRequest): Promise<string[]>

Purpose

Gets fund symbols.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FundSymbolsRequest`	Yes	None	None.
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<string[]>

Type-checked example

const result = await quoteClient.getFundSymbols({ lang: 'en_US' });
console.log(result);

Response example

[
  "string"
]

`getFundContracts`

Signature

async getFundContracts(req: FundContractsRequest): Promise<FundContractInfo[]>

Purpose

Gets fund contracts.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FundContractsRequest`	Yes	None	None.
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty; at most 500 fund symbols
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<FundContractInfo[]>

Field	Type	Description
symbol	string	Symbol code
name	string	Name
currency	string	Currency
fundType	string	Fund type
inception	string	Inception date
netAssetValue	number	Net asset value
expenseRatio	number	Expense ratio

Type-checked example

const result = await quoteClient.getFundContracts({ symbols: ['00003.HK'] });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "name": "string",
    "currency": "string",
    "fundType": "string",
    "inception": "string",
    "netAssetValue": 0,
    "expenseRatio": 0
  }
]

`getFundQuote`

Signature

async getFundQuote(req: FundQuoteRequest): Promise<FundQuote[]>

Purpose

Gets fund quote.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FundQuoteRequest`	Yes	None	None.
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty; at most 500 fund symbols
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<FundQuote[]>

Field	Type	Description
symbol	string	Symbol code
latestNav	number	Latest NAV
change	number	Price change
changeRate	number	Price change rate
date	string	Date

Type-checked example

const result = await quoteClient.getFundQuote({ symbols: ['00003.HK'] });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "latestNav": 0,
    "change": 0,
    "changeRate": 0,
    "date": "string"
  }
]

`getFundHistoryQuote`

Signature

async getFundHistoryQuote(req: FundHistoryQuoteRequest): Promise<FundHistoryQuote[]>

Purpose

Gets fund history quote.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`FundHistoryQuoteRequest`	Yes	None	None.
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty; at most 500 fund symbols
`req.beginTime`	`number \| undefined`	Yes	None	Unix timestamp in milliseconds
`req.endTime`	`number \| undefined`	Yes	None	Unix timestamp in milliseconds
`req.limit`	`number \| undefined`	No	None	None.
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<FundHistoryQuote[]>

Field	Type	Description
symbol	string	Symbol code
date	string	Date
nav	number	NAV

Type-checked example

const result = await quoteClient.getFundHistoryQuote({ symbols: ['00003.HK'], beginTime: Date.UTC(2026, 0, 1), endTime: Date.UTC(2026, 0, 31), limit: 100 });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "date": "string",
    "nav": 0
  }
]

`getWarrantQuote`

This API is not supported by the server.

Signature

async getWarrantQuote(req: WarrantBriefsRequest): Promise<WarrantBrief[]>

Purpose

Gets warrant quote.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`WarrantBriefsRequest`	Yes	None	None.
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<WarrantBrief[]>

Field	Type	Description
symbol	string	Symbol code
name	string	Name
latestPrice	number	Latest price
change	number	Price change
changeRate	number	Price change rate
volume	number	Trading volume
amount	number	Trading amount
underlying	string	Underlying symbol
issuer	string	Issuer
expiryDate	string	Expiry date
strikePrice	number	Strike price
warrantType	string	Warrant type

Type-checked example

const result = await quoteClient.getWarrantQuote({ symbols: ['12345'] });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "name": "string",
    "latestPrice": 0,
    "change": 0,
    "changeRate": 0,
    "volume": 0,
    "amount": 0,
    "underlying": "string",
    "issuer": "string",
    "expiryDate": "string",
    "strikePrice": 0,
    "warrantType": "string"
  }
]

`getWarrantFilter`

Signature

async getWarrantFilter(req: WarrantFilterRequest): Promise<WarrantFilterResult | undefined>

Purpose

Gets warrant filter.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`WarrantFilterRequest`	Yes	None	None.
`req.symbol`	`string \| undefined`	No	None	None.
`req.page`	`number \| undefined`	No	None	API default: 0; page numbering starts at 0
`req.pageSize`	`number \| undefined`	No	None	API default: 50; items per page
`req.sortFieldName`	`string \| undefined`	No	None	None.
`req.sortDir`	`string \| undefined`	No	None	Omission leaves sorting unspecified
`req.issuerName`	`string \| undefined`	No	None	None.
`req.expireYm`	`string \| undefined`	No	None	None.
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<WarrantFilterResult | undefined>

Field	Type	Description
total	number	Total count
items	WarrantBrief[]	Data items array
pageSize	number	Page size
page	number	Page number

Type-checked example

const result = await quoteClient.getWarrantFilter({ symbol: '00700', page: 0, pageSize: 20 });
console.log(result);

Response example

{
  "total": 0,
  "items": [
    {
      "symbol": "string",
      "name": "string",
      "latestPrice": 0,
      "change": 0,
      "changeRate": 0,
      "volume": 0,
      "amount": 0,
      "underlying": "string",
      "issuer": "string",
      "expiryDate": "string",
      "strikePrice": 0,
      "warrantType": "string"
    }
  ],
  "pageSize": 0,
  "page": 0
}

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