Datasets

Follow these steps to subscribe to an Index Option security:

1. Load the assembly files and data types in their own cell.

#load "../Initialize.csx"

2. Import the data types.

#load "../QuantConnect.csx"
#r "../Microsoft.Data.Analysis.dll"

using QuantConnect;
using QuantConnect.Data;
using QuantConnect.Algorithm;
using QuantConnect.Research;
using QuantConnect.Indicators;
using QuantConnect.Securities.Index;
using QuantConnect.Securities.IndexOption;
using Microsoft.Data.Analysis;

3. Instantiate a QuantBook.

var qb = new QuantBook();

qb = QuantBook()

4. Call the AddIndexadd_index method with a ticker and resolution.

var indexSymbol = qb.AddIndex("SPX", Resolution.Minute).Symbol;

index_symbol = qb.add_index("SPX", Resolution.MINUTE).symbol

To view the available indices, see Supported Assets.

If you do not pass a resolution argument, Resolution.MinuteResolution.MINUTE is used by default.


5. Call the AddIndexOptionadd_index_option method with the underlying Index Symbol and, if you want non-standard Index Options, the target Option ticker.

var option = qb.AddIndexOption(indexSymbol);

option = qb.add_index_option(index_symbol)

6. (Optional) Set a contract filter.

option.set_filter(-1, 1, 0, 90);

option.set_filter(-1, 1, 0, 90)

The filter determines which contracts the OptionHistoryoption_history method returns. If you don't set a filter, the default filter selects the contracts that have the following characteristics:

• Standard type (exclude weeklys)
• Within 1 strike price of the underlying asset price
• Expire within 31 days

If you want historical data on individual contracts and their OpenInterest, follow these steps to subscribe to individual Index Option contracts:

1. Call the GetOptionsContractList method with the underlying Index Symbol and a datetimeDateTime.

var startDate = new DateTime(2021, 12, 31);

// Standard contracts
var canonicalSymbol = QuantConnect.Symbol.CreateCanonicalOption(indexSymbol, Market.USA, "?SPX");
var contractSymbols = qb.OptionChainProvider.GetOptionContractList(canonicalSymbol, startDate);
            
// Weekly contracts
var weeklyCanonicalSymbol = QuantConnect.Symbol.CreateCanonicalOption(indexSymbol, "SPXW", Market.USA, "?SPXW");
var weeklyContractSymbols = qb.OptionChainProvider.GetOptionContractList(weeklyCanonicalSymbol, startDate)
    .Where(s => OptionSymbol.IsWeekly(s));

start_date = datetime(2021, 12, 31)

# Standard contracts
canonical_symbol = Symbol.create_canonical_option(index_symbol, Market.USA, "?SPX")
contract_symbols = qb.option_chain_provider.get_option_contract_list(canonical_symbol, start_date)

# Weekly contracts
weekly_canonical_symbol = Symbol.create_canonical_option(index_symbol, "SPXW", Market.USA, "?SPXW")
weekly_contract_symbols = qb.option_chain_provider.get_option_contract_list(weekly_canonical_symbol, start_date)
weekly_contract_symbols = [s for s in weekly_contract_symbols if OptionSymbol.is_weekly(s)]

This method returns a list of Symbol objects that reference the Option contracts that were trading at the given time. If you set a contract filter with SetFilterset_filter, it doesn't affect the results of GetOptionContractListget_option_contract_list.

2. Select the Symbol of the OptionContract object(s) for which you want to get historical data.

To filter and select contracts, you can use the following properties of each Symbol object:

Property	Description
ID.Dateid.date	The expiration date of the contract.
ID.StrikePriceid.strike_price	The strike price of the contract.
ID.OptionRightid.option_right	The contract type. The OptionRight enumeration has the following members:
ID.OptionStyleid.option_style	The contract style. The OptionStyle enumeration has the following members:

// Standard contracts
var contractSymbol = contractSymbols.Where(s => 
    s.ID.OptionRight == OptionRight.Call &&
    s.ID.StrikePrice == 4460 &&
    s.ID.Date == new DateTime(2022, 4, 14)).First();

// Weekly contracts
var weeklyContractSymbol = weeklyContractSymbols.Where(s => 
    s.ID.OptionRight == OptionRight.Call &&
    s.ID.StrikePrice == 4460 &&
    s.ID.Date == new DateTime(2021, 12, 31)).First();

# Standard contracts
contract_symbol = [s for s in contract_symbols 
    if s.id.option_right == OptionRight.CALL 
        and s.id.strike_price == 4460 
        and s.id.date == datetime(2022, 4, 14)][0]

# Weekly contracts
weekly_contract_symbol = [s for s in weekly_contract_symbols 
    if s.id.option_right == OptionRight.CALL 
        and s.id.strike_price == 4460 
        and s.id.date == datetime(2021, 12, 31)][0]

3. Call the AddIndexOptionContract method with an OptionContract Symbol and disable fill-forward.

qb.AddIndexOptionContract(contractSymbol, fillForward: false);

qb.add_index_option_contract(contract_symbol, fill_forward = False)

Disable fill-forward because there are only a few OpenInterest data points per day.

You need a subscription before you can request historical data for Index Option contracts. On the time dimension, you can request an amount of historical data based on a trailing number of bars, a trailing period of time, or a defined period of time. On the contract dimension, you can request historical data for a single contract, a subset of the contracts you created subscriptions for in your notebook, or all of the contracts in your notebook.

Before you request historical data, call the SetStartDateset_start_date method with a datetimeDateTime to reduce the risk of look-ahead bias.

qb.SetStartDate(startDate);

qb.set_start_date(start_date)

If you call the SetStartDateset_start_date method, the date that you pass to the method is the latest date for which your history requests will return data.

Trailing Number of Bars

To get historical data for a number of trailing bars, call the Historyhistory method with the contract Symbol object(s) and an integer.

// Slice objects
var singleHistorySlice = qb.History("SPX", 10);
var subsetHistorySlice = qb.History(new[] {"SPX"}, 10);
var allHistorySlice = qb.History(10);

// TradeBar objects
var singleHistoryTradeBars = qb.History<TradeBar>("SPX", 10);
var subsetHistoryTradeBars = qb.History<TradeBar>(new[] {"SPX"}, 10);
var allHistoryTradeBars = qb.History<TradeBar>(qb.Securities.Keys, 10);

// QuoteBar objects
var singleHistoryQuoteBars = qb.History<QuoteBar>("SPX", 10);
var subsetHistoryQuoteBars = qb.History<QuoteBar>(new[] {"SPX"}, 10);
var allHistoryQuoteBars = qb.History<QuoteBar>(qb.Securities.Keys, 10);

// OpenInterest objects
var singleHistoryOpenInterest = qb.History<OpenInterest>("SPX", 400);
var subsetHistoryOpenInterest = qb.History<OpenInterest>(new[] {"SPX"}, 400);
var allHistoryOpenInterest = qb.History<OpenInterest>(qb.Securities.Keys, 400);

# DataFrame of trade and quote data
single_history_df = qb.history("SPX", 10)
subset_history_df = qb.history(["SPX"], 10)
all_history_df = qb.history(qb.securities.keys(), 10)

# DataFrame of trade data
single_history_trade_bar_df = qb.history(TradeBar, "SPX", 10)
subset_history_trade_bar_df = qb.history(TradeBar, ["SPX"], 10)
all_history_trade_bar_df = qb.history(TradeBar, qb.securities.keys(), 10)

# DataFrame of quote data
single_history_quote_bar_df = qb.history(QuoteBar, "SPX", 10)
subset_history_quote_bar_df = qb.history(QuoteBar, ["SPX"], 10)
all_history_quote_bar_df = qb.history(QuoteBar, qb.securities.keys(), 10)

# DataFrame of open interest data
single_history_open_interest_df = qb.history(OpenInterest, "SPX", 400)
subset_history_open_interest_df = qb.history(OpenInterest, ["SPX"], 400)
all_history_open_interest_df = qb.history(OpenInterest, qb.securities.keys(), 400)

# Slice objects
all_history_slice = qb.history(10)

# TradeBar objects
single_history_trade_bars = qb.history[TradeBar]("SPX", 10)
subset_history_trade_bars = qb.history[TradeBar](["SPX"], 10)
all_history_trade_bars = qb.history[TradeBar](qb.securities.keys(), 10)

# QuoteBar objects
single_history_quote_bars = qb.history[QuoteBar]("SPX", 10)
subset_history_quote_bars = qb.history[QuoteBar](["SPX"], 10)
all_history_quote_bars = qb.history[QuoteBar](qb.securities.keys(), 10)

# OpenInterest objects
single_history_open_interest = qb.history[OpenInterest]("SPX", 400)
subset_history_open_interest = qb.history[OpenInterest](["SPX"], 400)
all_history_open_interest = qb.history[OpenInterest](qb.securities.keys(), 400)

The preceding calls return the most recent bars, excluding periods of time when the exchange was closed.

Trailing Period of Time

To get historical data for a trailing period of time, call the Historyhistory method with the contract Symbol object(s) and a TimeSpantimedelta.

// Slice objects
var singleHistorySlice = qb.History("SPX", TimeSpan.FromDays(3));
var subsetHistorySlice = qb.History(new[] {"SPX"}, TimeSpan.FromDays(3));
var allHistorySlice = qb.History(10);

// TradeBar objects
var singleHistoryTradeBars = qb.History<TradeBar>("SPX", TimeSpan.FromDays(3));
var subsetHistoryTradeBars = qb.History<TradeBar>(new[] {"SPX"}, TimeSpan.FromDays(3));
var allHistoryTradeBars = qb.History<TradeBar>(TimeSpan.FromDays(3));

// QuoteBar objects
var singleHistoryQuoteBars = qb.History<QuoteBar>("SPX", TimeSpan.FromDays(3), Resolution.Minute);
var subsetHistoryQuoteBars = qb.History<QuoteBar>(new[] {"SPX"}, TimeSpan.FromDays(3), Resolution.Minute);
var allHistoryQuoteBars = qb.History<QuoteBar>(qb.Securities.Keys, TimeSpan.FromDays(3), Resolution.Minute);


// OpenInterest objects
var singleHistoryOpenInterest = qb.History<OpenInterest>("SPX", TimeSpan.FromDays(2));
var subsetHistoryOpenInterest = qb.History<OpenInterest>(new[] {"SPX"}, TimeSpan.FromDays(2));
var allHistoryOpenInterest = qb.History<OpenInterest>(qb.Securities.Keys, TimeSpan.FromDays(2));

# DataFrame of trade and quote data
single_history_df = qb.history("SPX", timedelta(days=3))
subset_history_df = qb.history(["SPX"], timedelta(days=3))
all_history_df = qb.history(qb.securities.keys(), timedelta(days=3))

# DataFrame of trade data
single_history_trade_bar_df = qb.history(TradeBar, "SPX", timedelta(days=3))
subset_history_trade_bar_df = qb.history(TradeBar, ["SPX"], timedelta(days=3))
all_history_trade_bar_df = qb.history(TradeBar, qb.securities.keys(), timedelta(days=3))

# DataFrame of quote data
single_history_quote_bar_df = qb.history(QuoteBar, "SPX", timedelta(days=3))
subset_history_quote_bar_df = qb.history(QuoteBar, ["SPX"], timedelta(days=3))
all_history_quote_bar_df = qb.history(QuoteBar, qb.securities.keys(), timedelta(days=3))

# DataFrame of open interest data
single_history_open_interest_df = qb.history(OpenInterest, "SPX", timedelta(days=3))
subset_history_open_interest_df = qb.history(OpenInterest, ["SPX"], timedelta(days=3))
all_history_open_interest_df = qb.history(OpenInterest, qb.securities.keys(), timedelta(days=3))

# Slice objects
all_history_slice = qb.history(timedelta(days=3))

# TradeBar objects
single_history_trade_bars = qb.history[TradeBar]("SPX", timedelta(days=3))
subset_history_trade_bars = qb.history[TradeBar](["SPX"], timedelta(days=3))
all_history_trade_bars = qb.history[TradeBar](qb.securities.keys(), timedelta(days=3))

# QuoteBar objects
single_history_quote_bars = qb.history[QuoteBar]("SPX", timedelta(days=3), Resolution.MINUTE)
subset_history_quote_bars = qb.history[QuoteBar](["SPX"], timedelta(days=3), Resolution.MINUTE)
all_history_quote_bars = qb.history[QuoteBar](qb.securities.keys(), timedelta(days=3), Resolution.MINUTE) 


# OpenInterest objects
single_history_open_interest = qb.history[OpenInterest]("SPX", timedelta(days=2))
subset_history_open_interest = qb.history[OpenInterest](["SPX"], timedelta(days=2))
all_history_open_interest = qb.history[OpenInterest](qb.securities.keys(), timedelta(days=2))

The preceding calls return the most recent bars, excluding periods of time when the exchange was closed.

Defined Period of Time

To get historical data for individual Index Option contracts during a specific period of time, call the Historyhistory method with the Index Option contract Symbol object(s), a start DateTimedatetime, and an end DateTimedatetime. The start and end times you provide are based in the notebook time zone.

var startTime = new DateTime(2021, 12, 1);
var endTime = new DateTime(2021, 12, 31);

// Slice objects
var singleHistorySlice = qb.History("SPX", startTime, endTime);
var subsetHistorySlice = qb.History(new[] {"SPX"}, startTime, endTime);
var allHistorySlice = qb.History(startTime, endTime);

// TradeBar objects
var singleHistoryTradeBars = qb.History<TradeBar>("SPX", startTime, endTime);
var subsetHistoryTradeBars = qb.History<TradeBar>(new[] {"SPX"}, startTime, endTime);
var allHistoryTradeBars = qb.History<TradeBar>(qb.Securities.Keys, startTime, endTime);

// QuoteBar objects
var singleHistoryQuoteBars = qb.History<QuoteBar>("SPX", startTime, endTime, Resolution.Minute);
var subsetHistoryQuoteBars = qb.History<QuoteBar>(new[] {"SPX"}, startTime, endTime, Resolution.Minute);
var allHistoryQuoteBars = qb.History<QuoteBar>(qb.Securities.Keys, startTime, endTime, Resolution.Minute);


// OpenInterest objects
var singleHistoryOpenInterest = qb.History<OpenInterest>("SPX", startTime, endTime);
var subsetHistoryOpenInterest = qb.History<OpenInterest>(new[] {"SPX"}, startTime, endTime);
var allHistoryOpenInterest = qb.History<OpenInterest>(qb.Securities.Keys, startTime, endTime);

start_time = datetime(2021, 12, 1)
end_time = datetime(2021, 12, 31)

# DataFrame of trade and quote data
single_history_df = qb.history("SPX", start_time, end_time)
subset_history_df = qb.history(["SPX"], start_time, end_time)
all_history_df = qb.history(qb.securities.keys(), start_time, end_time)

# DataFrame of trade data
single_history_trade_bar_df = qb.history(TradeBar, "SPX", start_time, end_time)
subset_history_trade_bar_df = qb.history(TradeBar, ["SPX"], start_time, end_time)
all_history_trade_bar_df = qb.history(TradeBar, qb.securities.keys(), start_time, end_time)

# DataFrame of quote data
single_history_quote_bar_df = qb.history(QuoteBar, "SPX", start_time, end_time)
subset_history_quote_bar_df = qb.history(QuoteBar, ["SPX"], start_time, end_time)
all_history_quote_bar_df = qb.history(QuoteBar, qb.securities.keys(), start_time, end_time)

# DataFrame of open interest data
single_history_open_interest_df = qb.history(OpenInterest, "SPX", start_time, end_time)
subset_history_open_interest_df = qb.history(OpenInterest, ["SPX"], start_time, end_time)
all_history_trade_open_interest_df = qb.history(OpenInterest, qb.securities.keys(), start_time, end_time)

# TradeBar objects
single_history_trade_bars = qb.history[TradeBar]("SPX", start_time, end_time)
subset_history_trade_bars = qb.history[TradeBar](["SPX"], start_time, end_time)
all_history_trade_bars = qb.history[TradeBar](qb.securities.keys(), start_time, end_time)

# QuoteBar objects
single_history_quote_bars = qb.history[QuoteBar]("SPX", start_time, end_time, Resolution.MINUTE)
subset_history_quote_bars = qb.history[QuoteBar](["SPX"], start_time, end_time, Resolution.MINUTE)
all_history_quote_bars = qb.history[QuoteBar](qb.securities.keys(), start_time, end_time, Resolution.MINUTE)


# OpenInterest objects
single_history_open_interest = qb.history[OpenInterest]("SPX", start_time, end_time)
subset_history_open_interest = qb.history[OpenInterest](["SPX"], start_time, end_time)
all_history_open_interest = qb.history[OpenInterest](qb.securities.keys(), start_time, end_time)

To get historical data for all of the Index Option contracts that pass your filter during a specific period of time, call the OptionHistoryoption_history method with the canonical Index Option Symbol object, a start DateTimedatetime, and an end DateTimedatetime.

option_history = qb.option_history(option.Symbol, end_time-timedelta(days=2), end_time, Resolution.MINUTE, fill_forward=False, extended_market_hours=False)

var optionHistory = qb.OptionHistory(option.Symbol, endTime-TimeSpan.FromDays(2), endTime, Resolution.Minute, fillForward: False, extendedMarketHours: False);

The preceding calls return data that have a timestamp within the defined period of time.

The following table shows the available resolutions and data formats for Index Option contract subscriptions:

Resolution	TradeBar	QuoteBar	Trade Tick	Quote Tick
TickTICK
SecondSECOND
MinuteMINUTE
HourHOUR
DailyDAILY

The only market available for Index Options is Market.USA.

The data normalization mode doesn't affect data from history request. If you change the data normalization mode, it won't change the outcome.

You need some historical data to perform wrangling operations. The process to manipulate the historical data depends on its data type. To display pandas objects, run a cell in a notebook with the pandas object as the last line. To display other data formats, call the print method.

You need some historical data to perform wrangling operations. Use LINQ to wrangle the data and then call the Console.WriteLine method in a Jupyter Notebook to display the data. The process to manipulate the historical data depends on its data type.

DataFrame Objects

If your history request returns a DataFrame, the DataFrame has the following index levels:

1. Contract expiry
2. Contract strike price
3. Contract type (call or put)
4. Encoded contract Symbol
5. The EndTimeend_time of the data sample

The columns of the DataFrame are the data properties. Depending on how you request data, the DataFrame may contain data for the underlying security, which causes some of the index levels to be an empty string for the corresponding rows.

To select the rows of the contract(s) that expire at a specific time, index the loc property of the DataFrame with the expiry time.

all_history_df.loc[datetime(2022, 4, 14)]

If you remove the first three index levels, you can index the DataFrame with just the contract Symbol, similiar to how you would with non-derivative asset classes. To remove the first three index levels, call the droplevel method.

all_history_df.index = all_history_df.index.droplevel([0,1,2])

To select the historical data of a single Index Options contract, index the loc property of the DataFrame with the contract Symbol.

all_history_df.loc[contract_symbol]

To select a column of the DataFrame, index it with the column name.

all_history_df.loc[contract_symbol]['close']

If you request historical data for multiple Index Option contracts, you can transform the DataFrame so that it's a time series of close values for all of the Index Option contracts. To transform the DataFrame, select the column you want to display for each Index Option contract and then call the unstack method.

all_history_df['close'].unstack(level=0)

The DataFrame is transformed so that the column indices are the Symbol of each security and each row contains the close value.

The historical data methods don't return DataFrame objects, but you can create one for efficient vectorized data wrangling.

using Microsoft.Data.Analysis; 

var columns = new DataFrameColumn[] {
    new PrimitiveDataFrameColumn("Time", history.Select(x => x[contractSymbol].EndTime)),
    new DecimalDataFrameColumn(" Open", history.Select(x => x[contractSymbol].Open)),
    new DecimalDataFrameColumn(" High", history.Select(x => x[contractSymbol].High)),
    new DecimalDataFrameColumn(" Low", history.Select(x => x[contractSymbol].Low)),
    new DecimalDataFrameColumn(" Close", history.Select(x => x[contractSymbol].Close))
};
var df = new DataFrame(columns);
df

To select a particular column of the DataFrame, index it with the column name.

df[" close"]

Slice Objects

If the Historyhistory method returns Slice objects, iterate through the Slice objects to get each one. The Slice objects may not have data for all of your Index Options subscriptions. To avoid issues, check if the Slice contains data for your Index Option contract before you index it with the Index Options Symbol.

foreach (var slice in allHistorySlice) {
    if (slice.Bars.ContainsKey(contractSymbol))
    {
        var tradeBar = slice.Bars[contractSymbol];
    }
    if (slice.QuoteBars.ContainsKey(contractSymbol))
    {
        var quoteBar = slice.QuoteBars[contractSymbol];
    }
}

for slice in all_history_slice:
        if slice.bars.contains_key(contract_symbol):
        trade_bar = slice.bars[contract_symbol]
    if slice.quote_bars.contains_key(contract_symbol):
        quote_bar = slice.quote_bars[contract_symbol]

You can also iterate through each TradeBar and QuoteBar in the Slice.

foreach (var slice in allHistorySlice)
{
    foreach (var kvp in slice.Bars)
    {
        var symbol = kvp.Key;
        var tradeBar = kvp.Value;
    }
    foreach (var kvp in slice.QuoteBars)
    {
        var symbol = kvp.Key;
        var quoteBar = kvp.Value;
    }
}

for slice in all_history_slice:
    for kvp in slice.bars:
        symbol = kvp.key
        trade_bar = kvp.value
    for kvp in slice.quote_bars:
        symbol = kvp.key
        quote_bar = kvp.value

You can also use LINQ to select each TradeBar in the Slice for a given Symbol.

var tradeBars = allHistorySlice.Where(slice => slice.Bars.ContainsKey(contractSymbol)).Select(slice => slice.Bars[contractSymbol]);

TradeBar Objects

If the Historyhistory method returns TradeBar objects, iterate through the TradeBar objects to get each one.

foreach (var tradeBar in singleHistoryTradeBars)
{
    Console.WriteLine(tradeBar);
}

for trade_bar in single_history_trade_bars:
    print(trade_bar)

If the Historyhistory method returns TradeBars, iterate through the TradeBars to get the TradeBar of each Index Option contract. The TradeBars may not have data for all of your Index Options subscriptions. To avoid issues, check if the TradeBars object contains data for your security before you index it with the Index Options Symbol.

foreach (var tradeBars in allHistoryTradeBars)
{
    if (tradeBars.ContainsKey(contractSymbol))
    {
        var tradeBar = tradeBars[contractSymbol];
    }
}

for trade_bars in all_history_trade_bars:
    if trade_bars.contains_key(contract_symbol):
        trade_bar = trade_bars[contract_symbol]

You can also iterate through each of the TradeBars.

foreach (var tradeBars in allHistoryTradeBars)
{
    foreach (var kvp in tradeBars)
    {
        var symbol = kvp.Key;
        var tradeBar = kvp.Value;
    }
}

for trade_bars in all_history_trade_bars:
    for kvp in trade_bars:
        symbol = kvp.Key
        trade_bar = kvp.Value

QuoteBar Objects

If the Historyhistory method returns QuoteBar objects, iterate through the QuoteBar objects to get each one.

foreach (var quoteBar in singleHistoryQuoteBars)
{
    Console.WriteLine(quoteBar);
}

for quote_bar in single_history_quote_bars:
    print(quote_bar)

If the Historyhistory method returns QuoteBars, iterate through the QuoteBars to get the QuoteBar of each Index Option contract. The QuoteBars may not have data for all of your Index Options subscriptions. To avoid issues, check if the QuoteBars object contains data for your security before you index it with the Index Options Symbol.

foreach (var quoteBars in allHistoryQuoteBars)
{
    if (quoteBars.ContainsKey(contractSymbol))
    {
        var quoteBar = quoteBars[contractSymbol];
    }
}

for quote_bars in all_history_quote_bars:
    if quote_bars.contains_key(contract_symbol):
        quote_bar = quote_bars[contract_symbol]

You can also iterate through each of the QuoteBars.

foreach (var quoteBars in allHistoryQuoteBars)
{
    foreach (var kvp in quoteBars)
    {
        var symbol = kvp.Key;
        var quoteBar = kvp.Value;
    }
}

for quote_bars in all_history_quote_bars:
    for kvp in quote_bars:
        symbol = kvp.key
        quote_bar = kvp.value

OpenInterest Objects

If the Historyhistory method returns OpenInterest objects, iterate through the OpenInterest objects to get each one.

foreach (var openInterest in singleHistoryOpenInterest)
{
    Console.WriteLine(openInterest);
}

for open_interest in single_history_open_interest:
    print(open_interest)

If the Historyhistory method returns a dictionary of OpenInterest objects, iterate through the dictionary to get the OpenInterest of each Index Option contract. The dictionary of OpenInterest objects may not have data for all of your Index Options contract subscriptions. To avoid issues, check if the dictionary contains data for your contract before you index it with the Index Options contract Symbol.

foreach (var openInterestDict in allHistoryOpenInterest)
{
    if (openInterestDict.ContainsKey(contractSymbol))
    {
        var openInterest = openInterestDict[contractSymbol];
    }
}

for open_interest_dict in all_history_open_interest:
    if open_interest_dict.contains_key(contract_symbol):
        open_interest = open_interest_dict[contract_symbol]

You can also iterate through each of the OpenInterest dictionaries.

foreach (var openInterestDict in allHistoryOpenInterest)
{
    foreach (var kvp in openInterestDict)
    {
        var symbol = kvp.Key;
        var openInterest = kvp.Value;
    }
}

for open_interest_dict in all_history_open_interest:
    for kvp in open_interest_dict:
        symbol = kvp.key
        open_interest = kvp.value

OptionHistory Objects

The OptionHistoryoption_history method returns an OptionHistory object. To get each slice in the OptionHistory object, iterate through it.

foreach (var slice in optionHistory)
{
    foreach (var kvp in slice.OptionChains)
    {
        var canonicalSymbol = kvp.Key;
        var chain = kvp.Value;
        foreach (var contract in chain)
        {
            
        }
    }
}

for slice in option_history:
    for canonical_symbol, chain in slice.option_chains.items(): 
        for contract in chain:
            pass

To convert the OptionHistory object to a DataFrame that contains the trade and quote information of each contract and the underlying, call the GetAllData method.

option_history.get_all_data()

To get the expiration dates of all the contracts in an OptionHistory object, call the GetExpiryDates method.

option_history.get_expiry_dates()

To get the strike prices of all the contracts in an OptionHistory object, call the GetStrikes method.

option_history.get_strikes()

You need some historical Index Options data to produce plots. You can use many of the supported plotting librariesPlot.NET package to visualize data in various formats. For example, you can plot candlestick and line charts.

Candlestick Chart

Follow these steps to plot candlestick charts:

1. Get some historical data.

history = qb.history(contract_symbol, datetime(2021, 12, 30), datetime(2021, 12, 31))

var history = qb.History<QuoteBar>(contractSymbol, new DateTime(2021, 12, 30), new DateTime(2021, 12, 30));

2. Drop the first four index levels of DataFrame that returns.
   

history.index = history.index.droplevel([0,1,2,3])

3. Import the plotlyPlot.NET library.

import plotly.graph_objects as go

#r "../Plotly.NET.dll"
using Plotly.NET;
using Plotly.NET.LayoutObjects;

4. Create a Candlestick.
   

candlestick = go.Candlestick(x=history.index,
                             open=history['open'],
                             high=history['high'],
                             low=history['low'],
                             close=history['close'])

var chart = Chart2D.Chart.Candlestick<decimal, decimal, decimal, decimal, DateTime, string>(
    history.Select(x => x.Open),
    history.Select(x => x.High),
    history.Select(x => x.Low),
    history.Select(x => x.Close),
    history.Select(x => x.EndTime)
);

5. Create a Layout.

layout = go.Layout(title=go.layout.Title(text=f'{symbol.value} OHLC'),
                   xaxis_title='Date',
                   yaxis_title='Price',
                   xaxis_rangeslider_visible=False)

LinearAxis xAxis = new LinearAxis();
xAxis.SetValue("title", "Time");
LinearAxis yAxis = new LinearAxis();
yAxis.SetValue("title", "Price ($)");
Title title = Title.init($"{contractSymbol} OHLC");

Layout layout = new Layout();
layout.SetValue("xaxis", xAxis);
layout.SetValue("yaxis", yAxis);
layout.SetValue("title", title);

6. Create a Figure.
   

fig = go.Figure(data=[candlestick], layout=layout)

7. Assign the Layout to the chart.
   

chart.WithLayout(layout);

8. Show the Figure.
   

fig.show()

HTML(GenericChart.toChartHTML(chart))

The Jupyter Notebook displays a candlestick chart of the Option contract's price.

Line Chart

Follow these steps to plot line charts using built-in methodsPlotly.NET package:

1. Get some historical data.

history = qb.history(OpenInterest, contract_symbol, datetime(2021, 12, 1), datetime(2021, 12, 31))

var history = qb.History<OpenInterest>(contractSymbol, new DateTime(2021, 12, 1), new DateTime(2021, 12, 31));

2. Drop the first three index levels of the DataFrame that returns.

history.index = history.index.droplevel([0,1,2])

3. Select the open interest data.

history = history['openinterest'].unstack(level=0).ffill()

4. Rename the column to be the Symbol of each contract.

history.columns = [
    Symbol.get_alias(SecurityIdentifier.parse(x), index_symbol)
        for x in history.columns]

5. Call the plot method with a title and figure size.

history.plot(title="Open Interest", figsize=(16, 8))

6. Create Line charts.

var chart = Chart2D.Chart.Line<DateTime, decimal, string>(
    history.Select(x => x.EndTime),
    history.Select(x => x.Value)
);

7. Create a Layout.
   

LinearAxis xAxis = new LinearAxis();
xAxis.SetValue("title", "Time");
LinearAxis yAxis = new LinearAxis();
yAxis.SetValue("title", "Open Interest");
Title title = Title.init($"{contractSymbol} Open Interest");

Layout layout = new Layout();
layout.SetValue("xaxis", xAxis);
layout.SetValue("yaxis", yAxis);
layout.SetValue("title", title);

8. Assign the Layout to the chart.
   

chart.WithLayout(layout);

9. Show the plot.

plt.show()

HTML(GenericChart.toChartHTML(chart))

The Jupyter Notebook displays a line chart of open interest data.