Represents an entire chain of option contracts for a single underlying security. This type is IEnumerable<OptionContract> More...

Inheritance diagram for QuantConnect.Data.Market.OptionChain:

[legend]

Public Member Functions
	OptionChain (Symbol canonicalOptionSymbol, DateTime time, bool flatten=true)
	Initializes a new instance of the OptionChain class More...

	OptionChain (Symbol canonicalOptionSymbol, DateTime time, IEnumerable< OptionUniverse > contracts, SymbolProperties symbolProperties, bool flatten=true)
	Initializes a new option chain for a list of contracts as OptionUniverse instances More...

override BaseData	Clone ()
	Return a new instance clone of this object, used in fill forward More...

Public Member Functions inherited from QuantConnect.Data.Market.BaseChain< OptionContract, OptionContracts >
TAux	GetAux< TAux > (Symbol symbol)
	Gets the auxiliary data with the specified type and symbol More...

DataDictionary< TAux >	GetAux< TAux > ()
	Gets all auxiliary data of the specified type as a dictionary keyed by symbol More...

Dictionary< Symbol, List< BaseData > >	GetAuxList< TAux > ()
	Gets all auxiliary data of the specified type as a dictionary keyed by symbol More...

List< TAux >	GetAuxList< TAux > (Symbol symbol)
	Gets a list of auxiliary data with the specified type and symbol More...

IEnumerator< T >	GetEnumerator ()
	Returns an enumerator that iterates through the collection. More...

Additional Inherited Members
Public Attributes inherited from QuantConnect.Data.Market.BaseChain< OptionContract, OptionContracts >
PyObject	DataFrame
	The data frame representation of the option chain More...

Protected Member Functions inherited from QuantConnect.Data.Market.BaseChain< OptionContract, OptionContracts >
	BaseChain (MarketDataType dataType, bool flatten)
	Initializes a new default instance of the BaseChain<T, TContractsCollection> class More...

	BaseChain (Symbol canonicalOptionSymbol, DateTime time, MarketDataType dataType, bool flatten=true)
	Initializes a new instance of the BaseChain<T, TContractsCollection> class More...

	BaseChain (BaseChain< T, TContractsCollection > other)
	Initializes a new instance of the BaseChain<T, TContractsCollection> class as a copy of the specified chain More...

Properties inherited from QuantConnect.Data.Market.BaseChain< OptionContract, OptionContracts >
BaseData	Underlying `[get, set]`
	Gets the most recent trade information for the underlying. This may be a Tick or a TradeBar More...

Ticks	Ticks `[get, protected set]`
	Gets all ticks for every option contract in this chain, keyed by option symbol More...

TradeBars	TradeBars `[get, protected set]`
	Gets all trade bars for every option contract in this chain, keyed by option symbol More...

QuoteBars	QuoteBars `[get, protected set]`
	Gets all quote bars for every option contract in this chain, keyed by option symbol More...

TContractsCollection	Contracts `[get]`
	Gets all contracts in the chain, keyed by option symbol More...

HashSet< Symbol >	FilteredContracts `[get, protected set]`
	Gets the set of symbols that passed the Option.ContractFilter More...

Detailed Description

Represents an entire chain of option contracts for a single underlying security. This type is IEnumerable<OptionContract>

Definition at line 27 of file OptionChain.cs.

Constructor & Destructor Documentation

◆ OptionChain() [1/2]

QuantConnect.Data.Market.OptionChain.OptionChain	(	Symbol	canonicalOptionSymbol,
		DateTime	time,
		bool	flatten = `true`
	)

Initializes a new instance of the OptionChain class

Parameters

canonicalOptionSymbol	The symbol for this chain.
time	The time of this chain
flatten	Whether to flatten the data frame

Definition at line 35 of file OptionChain.cs.

Here is the caller graph for this function:

◆ OptionChain() [2/2]

QuantConnect.Data.Market.OptionChain.OptionChain	(	Symbol	canonicalOptionSymbol,
		DateTime	time,
		IEnumerable< OptionUniverse >	contracts,
		SymbolProperties	symbolProperties,
		bool	flatten = `true`
	)

Initializes a new option chain for a list of contracts as OptionUniverse instances

Parameters

canonicalOptionSymbol	The canonical option symbol
time	The time of this chain
contracts	The list of contracts data
symbolProperties	The option symbol properties
flatten	Whether to flatten the data frame

Definition at line 48 of file OptionChain.cs.

Here is the call graph for this function:

Member Function Documentation

◆ Clone()

override BaseData QuantConnect.Data.Market.OptionChain.Clone ( )

Return a new instance clone of this object, used in fill forward

Returns: A clone of the current object

Definition at line 72 of file OptionChain.cs.