Futures

Handling Data

Introduction

LEAN passes the data you request to the OnData method so you can make trading decisions. The default OnData method accepts a Slice object, but you can define additional OnData methods that accept different data types. For example, if you define an OnData method that accepts a TradeBar argument, it only receives TradeBar objects. The Slice object that the OnData method receives groups all the data together at a single moment in time. To access the Slice outside of the OnData method, use the CurrentSlice property of your algorithm.

All the data formats use DataDictionary objects to group data by Symbol and provide easy access to information. The plural of the type denotes the collection of objects. For instance, the TradeBars DataDictionary is made up of TradeBar objects. To access individual data points in the dictionary, you can index the dictionary with the contract ticker or Symbol, but we recommend you use the Symbol.

Futures Chains

FuturesChain objects represent an entire chain of contracts for a single underlying Future. They have the following properties:

To get the FuturesChain, index the FuturesChains property of the Slice with the continuous contract Symbol.

public override void OnData(Slice slice)
{
    if (slice.FuturesChains.TryGetValue(_contractSymbol.Canonical, out var chain))
    {
        //
    }
}
def OnData(self, slice: Slice) -> None:
    chain = slice.FuturesChains.get(self.contract_symbol.Canonical)
    if chain:
        pass

You can also loop through the FuturesChains property to get each FuturesChain.

public override void OnData(Slice slice)
{
    foreach (var kvp in slice.FuturesChains)
    {
        var continuousContractSymbol = kvp.Key;
        var chain = kvp.Value;
    }
}

public void OnData(FuturesChains futuresChains)
{
    foreach (var kvp in futuresChains)
    {
        var continuousContractSymbol = kvp.Key;
        var chain = kvp.Value;
    }
}
def OnData(self, slice: Slice) -> None:
    for continuous_contract_symbol, chain in slice.FuturesChains.items():
        pass

Futures Contracts

FuturesContract objects represent the data of a single Futures contract in the market. They have the following properties:

To get the Futures contracts in the Slice, use the Contracts property of the FuturesChain.

public override void OnData(Slice slice)
{
    if (slice.FuturesChains.TryGetValue(_contractSymbol.Canonical, out var chain))
    {
        if (chain.Contracts.TryGetValue(_contractSymbol, out var contract))
        {
            //
        }
    }
}

public void OnData(FuturesChains futuresChains)
{
    if (futuresChains.TryGetValue(_contractSymbol.Canonical, out var chain))
    {
        if (chain.Contracts.TryGetValue(_contractSymbol, out var contract))
        {
            //
        }
    }
}
def OnData(self, slice: Slice) -> None:
    chain = slice.FuturesChains.get(self.contract_symbol.Canonical)
    if chain:
        contract = chain.Contracts.get(self.contract_symbol)
        if contract:
            pass

Trades

TradeBar objects are price bars that consolidate individual trades from the exchanges. They contain the open, high, low, close, and volume of trading activity over a period of time.

TradeBar objects have the following properties:

To get the TradeBar objects in the Slice, index the Slice or index the Bars property of the Slice with the contract Symbol. If the contract doesn't actively trade or you are in the same time step as when you added the contract subscription, the Slice may not contain data for your Symbol. To avoid issues, check if the Slice contains data for your contract before you index the Slice with the contract Symbol.

public override void OnData(Slice slice)
{
    if (slice.Bars.ContainsKey(_contractSymbol))
    {
        var tradeBar = slice.Bars[_contractSymbol];
    }
}

public void OnData(TradeBars tradeBars)
{
    if (tradeBars.ContainsKey(_contractSymbol))
    {
        var tradeBar = tradeBars[_contractSymbol];
    }
}
def OnData(self, slice: Slice) -> None:
    if self.contract_symbol in slice.Bars:
        trade_bar = slice.Bars[self.contract_symbol]

You can also iterate through the TradeBars dictionary. The keys of the dictionary are the Symbol objects and the values are the TradeBar objects.

public override void OnData(Slice slice)
{
    foreach (var kvp in slice.Bars)
    {
        var symbol = kvp.Key;
        var tradeBar = kvp.Value;
    }
}

public void OnData(TradeBars tradeBars)
{
    foreach (var kvp in tradeBars)
    {
        var symbol = kvp.Key;
        var tradeBar = kvp.Value;
    }
}
def OnData(self, slice: Slice) -> None:
    for symbol, trade_bar in slice.Bars.items():
        pass

Quotes

QuoteBar objects are bars that consolidate NBBO quotes from the exchanges. They contain the open, high, low, and close prices of the bid and ask. The Open, High, Low, and Close properties of the QuoteBar object are the mean of the respective bid and ask prices. If the bid or ask portion of the QuoteBar has no data, the Open, High, Low, and Close properties of the QuoteBar copy the values of either the Bid or Ask instead of taking their mean.

QuoteBar objects have the following properties:

To get the QuoteBar objects in the Slice, index the QuoteBars property of the Slice with the contract Symbol. If the contract doesn't actively get quotes or you are in the same time step as when you added the contract subscription, the Slice may not contain data for your Symbol. To avoid issues, check if the Slice contains data for your contract before you index the Slice with the contract Symbol.

public override void OnData(Slice slice)
{
    if (slice.QuoteBars.ContainsKey(_contractSymbol))
    {
        var quoteBar = slice.QuoteBars[_contractSymbol];
    }
}

public void OnData(QuoteBars quoteBars)
{
    if (quoteBars.ContainsKey(_contractSymbol))
    {
        var quoteBar = quoteBars[_contractSymbol];
    }
}
def OnData(self, slice: Slice) -> None:
    if self.contract_symbol in slice.QuoteBars:
        quote_bar = slice.QuoteBars[self.contract_symbol]

You can also iterate through the QuoteBars dictionary. The keys of the dictionary are the Symbol objects and the values are the QuoteBar objects.

public override void OnData(Slice slice)
{
    foreach (var kvp in slice.QuoteBars)
    {
        var symbol = kvp.Key;
        var quoteBar = kvp.Value;
    }
}

public void OnData(QuoteBars quoteBars)
{
    foreach (var kvp in quoteBars)
    {
        var symbol = kvp.Key;
        var quoteBar = kvp.Value;
    }
}
def OnData(self, slice: Slice) -> None:
    for symbol, quote_bar in slice.QuoteBars.items():
        pass

QuoteBar objects let LEAN incorporate spread costs into your simulated trade fills to make backtest results more realistic.

Ticks

Tick objects represent a single trade or quote at a moment in time. A trade tick is a record of a transaction for the contract. A quote tick is an offer to buy or sell the contract at a specific price. Tick objects have the following properties:

Trade ticks have a non-zero value for the Quantity and Price properties, but they have a zero value for the BidPrice, BidSize, AskPrice, and AskSize properties. Quote ticks have non-zero values for BidPrice and BidSize properties or have non-zero values for AskPrice and AskSize properties. To check if a tick is a trade or a quote, use the TickType property.

In backtests, LEAN groups ticks into one millisecond buckets. In live trading, LEAN groups ticks into ~70-millisecond buckets. To get the Tick objects in the Slice, index the Ticks property of the Slice with a Symbol. If the contract doesn't actively trade or you are in the same time step as when you added the contract subscription, the Slice may not contain data for your Symbol. To avoid issues, check if the Slice contains data for your contract before you index the Slice with the contract Symbol.

public override void OnData(Slice slice)
{
    if (slice.Ticks.ContainsKey(_contractSymbol))
    {
        var ticks = slice.Ticks[_contractSymbol];
        foreach (var tick in ticks)
        {
            //
        }
    }
}

public void OnData(Ticks ticks)
{
    if (ticks.ContainsKey(_contractSymbol))
    {
        foreach (var tick in ticks[_contractSymbol])
        {
            //
        }
    }
}
def OnData(self, slice: Slice) -> None:
    if self.contract_symbol in slice.Ticks:
        ticks = slice.Ticks[self.contract_symbol]
        for tick in ticks:
            pass

You can also iterate through the Ticks dictionary. The keys of the dictionary are the Symbol objects and the values are the List<Tick>list[Tick] objects.

public override void OnData(Slice slice)
{
    foreach (var kvp in slice.Ticks)
    {
        var symbol = kvp.Key;
        var ticks = kvp.Value;
        foreach (var tick in ticks)
        {
            //
        }
    }
}

public void OnData(Ticks ticks)
{
    foreach (var kvp in ticks)
    {
        var symbol = kvp.Key;
        foreach (var tick in kvp.Value)
        {
            //
        }
    }
}
def OnData(self, slice: Slice) -> None:
    for symbol, ticks in slice.Ticks.items():
        for tick in ticks:
            pass

Tick data is raw and unfiltered, so it can contain bad ticks that skew your trade results. For example, some ticks come from dark pools, which aren't tradable. We recommend you only use tick data if you understand the risks and are able to perform your own online tick filtering.

Open Interest

Open interest is the number of outstanding contracts that haven't been settled. It provides a measure of investor interest and the market liquidity, so it's a popular metric to use for contract selection. Open interest is calculated once per day. To get the latest open interest value, use the OpenInterest property of the Future or FutureContract.

public override void OnData(Slice slice)
{
    if (slice.FuturesChains.TryGetValue(_contractSymbol.Canonical, out var chain))
    {
        if (chain.Contracts.TryGetValue(_contractSymbol, out var contract))
        {
            var openInterest = contract.OpenInterest;
        }
    }
}

public void OnData(FuturesChains futuresChains)
{
    if (futuresChains.TryGetValue(_contractSymbol.Canonical, out var chain))
    {
        if (chain.Contracts.TryGetValue(_contractSymbol, out var contract))
        {
            var openInterest = contract.OpenInterest;
        }
    }
}
def OnData(self, slice: Slice) -> None:
    chain = slice.FuturesChains.get(self.contract_symbol.Canonical)
    if chain:
        contract = chain.Contracts.get(self.contract_symbol)
        if contract:
            open_interest = contract.OpenInterest

If you define an OnData method that accepts a FuturesChains object, LEAN doesn't currently call it. We have an open GitHub Issue to add this functionality. Subscribe to GitHub Issue #6419 to track the feature progress.

Symbol Changes

When the continuous contract rolls over, LEAN passes a SymbolChangedEvent to your OnData method, which contains the old contract Symbol and the new contract Symbol. SymbolChangedEvent objects have the following properties:

To get the SymbolChangedEvent, use the SymbolChangedEvents property of the Slice.

public override void OnData(Slice slice)
{
    foreach(var changeEvent in slice.SymbolChangedEvents.Values)
    {
        Log($"Contract rollover from {changed_event.OldSymbol} to {changed_event.NewSymbol}");
    }
}
def OnData(self, slice: Slice) -> None:
    for changed_event in slice.SymbolChangedEvents.Values:
        self.Log(f"Contract rollover from {changed_event.OldSymbol} to {changed_event.NewSymbol}")

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: