/* * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals. * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ using System; using System.Linq; using QuantConnect.Data; using QuantConnect.Data.Market; using System.Collections.Generic; using QuantConnect.Securities.Option.StrategyMatcher; namespace QuantConnect.Algorithm.CSharp { /// /// Regression algorithm exercising an equity Put Butterfly option strategy and asserting it's being detected by Lean and works as expected /// public class OptionEquityPutButterflyRegressionAlgorithm : OptionEquityBaseStrategyRegressionAlgorithm { /// /// OnData event is the primary entry point for your algorithm. Each new data point will be pumped in here. /// /// Slice object keyed by symbol containing the stock data public override void OnData(Slice slice) { if (!Portfolio.Invested) { OptionChain chain; if (IsMarketOpen(_optionSymbol) && slice.OptionChains.TryGetValue(_optionSymbol, out chain)) { var contracts = chain .Where(contract => contract.Right == OptionRight.Put) .GroupBy(x => x.Expiry) .First() .OrderBy(x => x.Strike) .ToList(); var distanceBetweenStrikes = 2.5m; var lowerPut = contracts.First(); var middlePut = contracts.First(contract => contract.Expiry == lowerPut.Expiry && contract.Strike == lowerPut.Strike + distanceBetweenStrikes); var highestPut = contracts.First(contract => contract.Expiry == lowerPut.Expiry && contract.Strike == middlePut.Strike + distanceBetweenStrikes); var initialMargin = Portfolio.MarginRemaining; MarketOrder(lowerPut.Symbol, 10); MarketOrder(middlePut.Symbol, -20); MarketOrder(highestPut.Symbol, 10); AssertOptionStrategyIsPresent(OptionStrategyDefinitions.ButterflyPut.Name, 10); var freeMarginPostTrade = Portfolio.MarginRemaining; var expectedMarginUsage = 0; if (expectedMarginUsage != Portfolio.TotalMarginUsed) { throw new RegressionTestException("Unexpect margin used!"); } // we payed the ask and value using the assets price var priceSpreadDifference = GetPriceSpreadDifference(lowerPut.Symbol, middlePut.Symbol, highestPut.Symbol); if (initialMargin != (freeMarginPostTrade + expectedMarginUsage + _paidFees - priceSpreadDifference)) { throw new RegressionTestException("Unexpect margin remaining!"); } } } } /// /// Data Points count of all timeslices of algorithm /// public override long DataPoints => 15023; /// /// Data Points count of the algorithm history /// public override int AlgorithmHistoryDataPoints => 0; /// /// Final status of the algorithm /// public AlgorithmStatus AlgorithmStatus => AlgorithmStatus.Completed; /// /// This is used by the regression test system to indicate what the expected statistics are from running the algorithm /// public override Dictionary ExpectedStatistics => new Dictionary { {"Total Orders", "3"}, {"Average Win", "0%"}, {"Average Loss", "0%"}, {"Compounding Annual Return", "0%"}, {"Drawdown", "0%"}, {"Expectancy", "0"}, {"Start Equity", "200000"}, {"End Equity", "197124"}, {"Net Profit", "0%"}, {"Sharpe Ratio", "0"}, {"Sortino Ratio", "0"}, {"Probabilistic Sharpe Ratio", "0%"}, {"Loss Rate", "0%"}, {"Win Rate", "0%"}, {"Profit-Loss Ratio", "0"}, {"Alpha", "0"}, {"Beta", "0"}, {"Annual Standard Deviation", "0"}, {"Annual Variance", "0"}, {"Information Ratio", "0"}, {"Tracking Error", "0"}, {"Treynor Ratio", "0"}, {"Total Fees", "$26.00"}, {"Estimated Strategy Capacity", "$280000.00"}, {"Lowest Capacity Asset", "GOOCV 306CZL2DIL4G6|GOOCV VP83T1ZUHROL"}, {"Portfolio Turnover", "25.77%"}, {"Drawdown Recovery", "0"}, {"OrderListHash", "90ff39e71c0e1dea734cd5e7e45f50d4"} }; } }