Lean  $LEAN_TAG$
QuantConnect.Lean.Engine.DataFeeds.BacktestingOptionChainProvider Class Reference

An implementation of IOptionChainProvider that reads the list of contracts from open interest zip data files More...

Inheritance diagram for QuantConnect.Lean.Engine.DataFeeds.BacktestingOptionChainProvider:
[legend]

Public Member Functions

 BacktestingOptionChainProvider (IDataCacheProvider dataCacheProvider, IMapFileProvider mapFileProvider)
 Creates a new instance More...
 
virtual IEnumerable< SymbolGetOptionContractList (Symbol symbol, DateTime date)
 Gets the list of option contracts for a given underlying symbol More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Lean.Engine.DataFeeds.BacktestingChainProvider
 BacktestingChainProvider (IDataCacheProvider dataCacheProvider)
 Creates a new instance More...
 
IEnumerable< SymbolGetSymbols (Symbol canonicalSymbol, DateTime date)
 Get the contract symbols associated with the given canonical symbol and date More...
 
- Static Protected Member Functions inherited from QuantConnect.Lean.Engine.DataFeeds.BacktestingChainProvider
static bool IsContractExpired (Symbol symbol, DateTime date)
 Helper method to determine if a contract is expired for the requested date More...
 
- Properties inherited from QuantConnect.Lean.Engine.DataFeeds.BacktestingChainProvider
IDataCacheProvider DataCacheProvider [get]
 The data cache instance to use More...
 

Detailed Description

An implementation of IOptionChainProvider that reads the list of contracts from open interest zip data files

Definition at line 26 of file BacktestingOptionChainProvider.cs.

Constructor & Destructor Documentation

◆ BacktestingOptionChainProvider()

QuantConnect.Lean.Engine.DataFeeds.BacktestingOptionChainProvider.BacktestingOptionChainProvider ( IDataCacheProvider  dataCacheProvider,
IMapFileProvider  mapFileProvider 
)

Creates a new instance

Parameters
dataCacheProviderThe data cache provider instance to use
mapFileProviderThe map file provider instance to use

Definition at line 35 of file BacktestingOptionChainProvider.cs.

Member Function Documentation

◆ GetOptionContractList()

virtual IEnumerable<Symbol> QuantConnect.Lean.Engine.DataFeeds.BacktestingOptionChainProvider.GetOptionContractList ( Symbol  symbol,
DateTime  date 
)
virtual

Gets the list of option contracts for a given underlying symbol

Parameters
symbolThe option or the underlying symbol to get the option chain for. Providing the option allows targetting an option ticker different than the default e.g. SPXW
dateThe date for which to request the option chain (only used in backtesting)
Returns
The list of option contracts

Implements QuantConnect.Interfaces.IOptionChainProvider.

Reimplemented in QuantConnect.Lean.Engine.DataFeeds.LiveOptionChainProvider.

Definition at line 48 of file BacktestingOptionChainProvider.cs.

Here is the call graph for this function:

The documentation for this class was generated from the following file: