Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGetOptionChainsRequest

Hierarchy

  • IGetOptionChainsRequest

Index

Properties

chainType?: ChainType

The type of option chain. Default: CALLPUT.

expiryDay?: number

Indicates the expiry day corresponding to which the optionchain needs to be fetched.

expiryMonth?: number

Indicates the expiry month corresponding to which the optionchain needs to be fetched.

expiryYear?: number

Indicates the expiry year corresponding to which the optionchain needs to be fetched.

includeWeekly?: boolean

The include weekly options request. Default: false.

noOfStrikes?: number

Indicates number of strikes for which the optionchain needs to be fetched.

optionCategory?: OptionCategory

The option category. Default: STANDARD.

priceType?: PriceType

The price type. Default: ATNM.

skipAdjusted?: boolean

The skip adjusted request. Default: true.

strikePriceNear?: number

The optionchians fetched will have strike price nearer to this value.

symbol: string

The market symbol for the instrument; for example, GOOG.

Generated using TypeDoc