Options

Example context

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

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

`getOptionExpiration`

Signature

async getOptionExpiration(symbols: string[], market?: string): Promise<OptionExpiration[]>

Purpose

Gets option expiration.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`symbols`	`string[]`	Yes	None	Non-empty; at most 30 underlyings
`market`	`string`	No	None	None.

Returns

Promise<OptionExpiration[]>

Field	Type	Description
symbol	string	Symbol code
optionSymbols	string[]	Option symbols list
dates	string[]	Expiration date list
timestamps	number[]	Expiration timestamps
periods	string[]	Periods list
counts	number[]	Counts per expiration

Type-checked example

const result = await quoteClient.getOptionExpiration(['AAPL'], 'US');
console.log(result);

Response example

[
  {
    "symbol": "string",
    "optionSymbols": [
      "string"
    ],
    "dates": [
      "string"
    ],
    "timestamps": [
      0
    ],
    "periods": [
      "string"
    ],
    "counts": [
      0
    ]
  }
]

Special option symbols for indices

S&P 500 (.SPX): monthly options use SPX; weekly and quarterly options use SPXW.
Nasdaq-100: monthly options use NDX; weekly options use NDXP.
VIX: monthly options use VIX; weekly options use VIXW.

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

`getOptionChain`

Signature

async getOptionChain(items: Array<[string, string]>, timezone?: string, returnGreekValue?: boolean, optionFilter?: OptionChainFilter): Promise<OptionChain[]>

Purpose

Gets option chain.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`items`	`Array<[string, string]>`	Yes	None	Non-empty; at most 30 entries, each containing a symbol and a `YYYY-MM-DD` expiry
`timezone`	`string`	No	Inferred from each symbol	IANA timezone; defaults to `America/New_York` for US symbols and `Asia/Hong_Kong` for `.HK` symbols
`returnGreekValue`	`boolean`	No	None	Deprecated; new integrations should not request Greeks.
`optionFilter`	`OptionChainFilter`	No	None	None.
`optionFilter.inTheMoney`	`boolean \| undefined`	No	None	None.
`optionFilter.impliedVolatility`	`Range \| undefined`	No	None	None.
`optionFilter.openInterest`	`Range \| undefined`	No	None	None.
`optionFilter.greeks`	`OptionChainFilterGreeks \| undefined`	No	None	Deprecated; new integrations should not filter by Greeks.

Deprecated: returnGreekValue, optionFilter.greeks, and the option-chain delta, gamma, theta, vega, and rho response fields are deprecated. These values update daily and are not suitable for intraday decisions; new integrations should not request or filter by them.

Returns

Promise<OptionChain[]>

Field	Type	Description
symbol	string	Symbol code
expiry	number	Expiration date
items	OptionChainRow[]	Data items array

Type-checked example

const result = await quoteClient.getOptionChain([['AAPL', '2026-06-19']], 'America/New_York', false, { inTheMoney: true });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "expiry": 0,
    "items": [
      "OptionChainRow"
    ]
  }
]

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

`getOptionKline`

Signature

async getOptionKline(identifiers: string[], period: string, beginTime: number = -1, endTime: number = -1, timezone?: string, limit?: number, sortDir?: string): Promise<Kline[]>

Purpose

Gets option candlestick bars (K-line data).

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`identifiers`	`string[]`	Yes	None	Non-empty; at most 30 OCC-style option identifiers
`period`	`string`	Yes	None	None.
`beginTime`	`number`	No	-1	None.
`endTime`	`number`	No	-1	None.
`timezone`	`string`	No	None	None.
`limit`	`number`	No	None	Omission uses 300; values above 1,200 are capped at 1,200
`sortDir`	`string`	No	None	`asc` or `desc`; omission leaves the sort direction unspecified

Returns

Promise<Kline[]>

Field	Type	Description
symbol	string	Symbol code
period	string	Bar period
nextPageToken	string	Next page token
items	KlineItem[]	Data items array

Type-checked example

const result = await quoteClient.getOptionKline(['AAPL  260619C00150000'], 'day', -1, -1, 'America/New_York', 100, 'desc');
console.log(result);

Response example

[
  {
    "symbol": "string",
    "period": "string",
    "nextPageToken": "string",
    "items": [
      "KlineItem"
    ]
  }
]

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

`getOptionQuote`

Signature

async getOptionQuote(identifiers: string[], timezone?: string): Promise<Brief[]>

Purpose

Gets option quote.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`identifiers`	`string[]`	Yes	None	Non-empty; at most 30 OCC-style option identifiers
`timezone`	`string`	No	None	None.

Returns

Promise<Brief[]>

Field	Type	Description
symbol	string	Symbol code
open	number	Open price
high	number	High price
low	number	Low price
close	number	Close price
preClose	number	Previous close price
latestPrice	number	Latest price
latestTime	number	Latest trade time (ms timestamp)
askPrice	number	Ask price (best offer)
askSize	number	Ask size
bidPrice	number	Bid price (best bid)
bidSize	number	Bid size
volume	number	Trading volume
status	string	Trading status
adjPreClose	number	Adjusted previous close
change	number	Price change
changeRate	number	Price change rate
amplitude	number	Amplitude
expiry	string	Expiration date
strike	string	Strike price
right	string	Option right (CALL/PUT)
multiplier	number	Contract multiplier
openInterest	number	Open interest
markPrice	number	Mark price
preMarkPrice	number	Previous mark price
markTimestamp	number	Timestamp of the mark price (ms)
midPrice	number	Mid price
preMidPrice	number	Previous mid price
midTimestamp	number	Timestamp of the mid price (ms)

Type-checked example

const result = await quoteClient.getOptionQuote(['AAPL  260619C00150000'], 'America/New_York');
console.log(result);

Response example

[
  {
    "symbol": "string",
    "open": 0,
    "high": 0,
    "low": 0,
    "close": 0,
    "preClose": 0,
    "latestPrice": 0,
    "latestTime": 0,
    "askPrice": 0,
    "askSize": 0,
    "bidPrice": 0,
    "bidSize": 0,
    "volume": 0,
    "status": "string",
    "adjPreClose": 0,
    "change": 0,
    "changeRate": 0,
    "amplitude": 0,
    "expiry": "string",
    "strike": "string",
    "right": "string",
    "multiplier": 0,
    "openInterest": 0
  }
]

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

`getOptionTradeTicks`

Signature

async getOptionTradeTicks(req: OptionTradeTicksRequest): Promise<TradeTick[]>

Purpose

Gets option trade ticks.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionTradeTicksRequest`	Yes	None	None.
`req.contracts`	`OptionQueryItem[] \| undefined`	Yes	None	Non-empty; at most 30 option contracts
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<TradeTick[]>

Field	Type	Description
symbol	string	Symbol code
beginIndex	number	Begin index
endIndex	number	End index
items	TradeTickItem[]	Data items array

Type-checked example

const result = await quoteClient.getOptionTradeTicks({ contracts: [{ symbol: 'AAPL', expiry: Date.UTC(2026, 5, 19), strike: '150', right: 'CALL' }] });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "beginIndex": 0,
    "endIndex": 0,
    "items": [
      "TradeTickItem"
    ]
  }
]

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

`getOptionTimeline`

Signature

async getOptionTimeline(req: OptionTimelineRequest): Promise<Timeline[]>

Purpose

Gets option timeline (intraday data).

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionTimelineRequest`	Yes	None	None.
`req.optionQuery`	`OptionQueryItem[] \| undefined`	No	None	None.
`req.market`	`string \| undefined`	No	None	None.
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<Timeline[]>

Field	Type	Description
symbol	string	Symbol code
period	string	Timeline period
preClose	number	Previous close price
intraday	TimelineBucket	Intraday timeline data
preHours	TimelineBucket	Pre-market timeline data
afterHours	TimelineBucket	After-hours timeline data

Type-checked example

const result = await quoteClient.getOptionTimeline({ optionQuery: [{ symbol: 'AAPL', expiry: Date.UTC(2026, 5, 19), strike: '150', right: 'CALL' }], market: 'US' });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "period": "string",
    "preClose": 0,
    "intraday": {
      "items": [
        "TimelineItem"
      ]
    },
    "preHours": {
      "items": [
        "TimelineItem"
      ]
    },
    "afterHours": {
      "items": [
        "TimelineItem"
      ]
    }
  }
]

`getOptionDepth`

Signature

async getOptionDepth(req: OptionDepthRequest): Promise<Depth[]>

Purpose

Gets option market depth (order book).

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionDepthRequest`	Yes	None	None.
`req.optionBasic`	`OptionQueryItem[] \| undefined`	Yes	None	Non-empty; at most 30 option contracts
`req.market`	`string \| undefined`	No	None	None.
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<Depth[]>

Field	Type	Description
symbol	string	Symbol code
asks	DepthLevel[]	Ask order queue
bids	DepthLevel[]	Bid order queue

Type-checked example

const result = await quoteClient.getOptionDepth({ optionBasic: [{ symbol: 'AAPL', expiry: Date.UTC(2026, 5, 19), strike: '150', right: 'CALL' }], market: 'US' });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "asks": [
      "DepthLevel"
    ],
    "bids": [
      "DepthLevel"
    ]
  }
]

`getOptionSymbols`

This API is not supported by the server.

Signature

async getOptionSymbols(req: OptionSymbolsRequest): Promise<OptionSymbol[]>

Purpose

Gets option symbols.

Parameters, defaults, and constraints

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

Returns

Promise<OptionSymbol[]>

Field	Type	Description
symbol	string	Symbol code
market	string	Market
nameCN	string	Chinese name
nameEN	string	English name

Type-checked example

const result = await quoteClient.getOptionSymbols({ market: 'US' });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "market": "string",
    "nameCN": "string",
    "nameEN": "string"
  }
]

`getOptionAnalysis`

Signature

async getOptionAnalysis(req: OptionAnalysisRequest): Promise<OptionAnalysis[]>

Purpose

Gets option analysis.

Parameters, defaults, and constraints

Parameter	Type	Required	SDK default	Constraints
`req`	`OptionAnalysisRequest`	Yes	None	None.
`req.symbols`	`string[] \| undefined`	Yes	None	Non-empty; at most 10 underlyings
`req.market`	`string \| undefined`	No	None	`US` or `HK`
`req.period`	`string \| undefined`	No	`52week` (API)	Analysis period
`req.requireVolatilityList`	`boolean \| undefined`	No	`false` (API)	The historical volatility list is returned only when set to `true`
`req.lang`	`string \| undefined`	No	None	None.

Returns

Promise<OptionAnalysis[]>

Field	Type	Description
symbol	string	Symbol code
impliedVol30Days	number	30-day implied volatility
hisVolatility	number	Historical volatility
ivHisVRatio	number	IV/HV ratio
callPutRatio	number	Call/put ratio
impliedVolMetric	ImpliedVolMetric	Implied volatility metric
volatilityList	OptionVolatilityPoint[]	Volatility list

Type-checked example

const result = await quoteClient.getOptionAnalysis({ symbols: ['AAPL'], market: 'US', period: '26week' });
console.log(result);

Response example

[
  {
    "symbol": "string",
    "impliedVol30Days": 0,
    "hisVolatility": 0,
    "ivHisVRatio": 0,
    "callPutRatio": 0,
    "impliedVolMetric": {
      "period": "string",
      "percentile": 0,
      "rank": 0
    },
    "volatilityList": [
      "OptionVolatilityPoint"
    ]
  }
]

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