Class Option

Option contact.

Hierarchy

  • Option

Implements

Constructors

constructor

Properties

currency? exchange? expiry multiplier right secType strike symbol

Accessors

lastTradeDateOrContractMonth

Constructors

constructor

  • Parameters

    • symbol: string
    • expiry: string
    • strike: number
    • right: OptionType
    • Optional exchange: string
    • Optional currency: string

    Returns Option

Properties

Optional currency

currency?: string

The trading currency.

Optional exchange

exchange?: string

The destination exchange.

expiry

expiry: string

multiplier

multiplier: number = 100

The instrument's multiplier (i.e. options, futures).

right

right: OptionType

Either Put or Call (i.e. Options). Valid values are P, PUT, C, CALL.

secType

secType: SecType = SecType.OPT

The security type

strike

strike: number

The option's strike price.

symbol

symbol: string

The asset symbol.

Accessors

lastTradeDateOrContractMonth

  • get lastTradeDateOrContractMonth(): string

  • The contract's last trading day or contract month (for Options and Futures).

    Strings with format YYYYMM will be interpreted as the Contract Month whereas YYYYMMDD will be interpreted as Last Trading Day.

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc