chore: import upstream snapshot with attribution

2026-07-13 13:02:50 +08:00
commit 0fc60fdcb1
5008 changed files with 910633 additions and 0 deletions
@@ -0,0 +1,159 @@
+/*
+ * 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.Linq;
+using QuantConnect.Data;
+using QuantConnect.Orders;
+using QuantConnect.Interfaces;
+using QuantConnect.Data.Market;
+using System.Collections.Generic;
+using QuantConnect.Securities.Option;
+using System;
+
+namespace QuantConnect.Algorithm.CSharp
+{
+    /// <summary>
+    /// This example demonstrates how to add and trade SPX index weekly option strategy
+    /// </summary>
+    /// <meta name="tag" content="using data" />
+    /// <meta name="tag" content="options" />
+    /// <meta name="tag" content="indexes" />
+    public class BasicTemplateSPXWeeklyIndexOptionsStrategyAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
+    {
+        private Symbol _spxOption;
+
+        /// <summary>
+        /// Initialize your algorithm and add desired assets.
+        /// </summary>
+        public override void Initialize()
+        {
+            SetStartDate(2021, 1, 4);
+            SetEndDate(2021, 1, 10);
+            SetCash(1000000);
+
+            var spx = AddIndex("SPX").Symbol;
+
+            // weekly option SPX contracts
+            var spxw = AddIndexOption(spx, "SPXW");
+            spxw.SetFilter(u => u.Strikes(-1, +1)
+                 // single week ahead since there are many SPXW contracts and we want to preserve performance
+                 .Expiration(0, 7)
+                 .IncludeWeeklys());
+
+            _spxOption = spxw.Symbol;
+        }
+
+        public override void OnData(Slice slice)
+        {
+            if (Portfolio.Invested)
+            {
+                return;
+            }
+
+            OptionChain chain;
+            if (slice.OptionChains.TryGetValue(_spxOption, out chain))
+            {
+                // we find the first expiration group of call options and order them in ascending strike
+                var contracts = chain
+                    .Where(x => x.Right == OptionRight.Call)
+                    .OrderBy(x => x.Expiry)
+                    .GroupBy(x => x.Expiry)
+                    .First()
+                    .OrderBy(x => x.Strike)
+                    .ToList();
+
+                if (contracts.Count > 1)
+                {
+                    var smallerStrike = contracts[0];
+                    var higherStrike = contracts[1];
+
+                    // if found, buy until it expires
+                    var optionStrategy = OptionStrategies.BearCallSpread(_spxOption, smallerStrike.Strike, higherStrike.Strike, smallerStrike.Expiry);
+                    Buy(optionStrategy, 1);
+                }
+            }
+        }
+
+        public override void OnOrderEvent(OrderEvent orderEvent)
+        {
+            Debug(orderEvent.ToString());
+            if (orderEvent.Symbol.ID.Symbol != "SPXW")
+            {
+                throw new RegressionTestException("Unexpected order event symbol!");
+            }
+        }
+
+        /// <summary>
+        /// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
+        /// </summary>
+        public virtual bool CanRunLocally { get; } = true;
+
+        /// <summary>
+        /// This is used by the regression test system to indicate which languages this algorithm is written in.
+        /// </summary>
+        public virtual List<Language> Languages { get; } = new() { Language.CSharp };
+
+        /// <summary>
+        /// Data Points count of all timeslices of algorithm
+        /// </summary>
+        public virtual long DataPoints => 26399;
+
+        /// <summary>
+        /// Data Points count of the algorithm history
+        /// </summary>
+        public virtual int AlgorithmHistoryDataPoints => 0;
+
+        /// <summary>
+        /// Final status of the algorithm
+        /// </summary>
+        public AlgorithmStatus AlgorithmStatus => AlgorithmStatus.Completed;
+
+        /// <summary>
+        /// This is used by the regression test system to indicate what the expected statistics are from running the algorithm
+        /// </summary>
+        public virtual Dictionary<string, string> ExpectedStatistics => new Dictionary<string, string>
+        {
+            {"Total Orders", "10"},
+            {"Average Win", "0.46%"},
+            {"Average Loss", "-0.01%"},
+            {"Compounding Annual Return", "60.924%"},
+            {"Drawdown", "0.600%"},
+            {"Expectancy", "29.469"},
+            {"Start Equity", "1000000"},
+            {"End Equity", "1006115"},
+            {"Net Profit", "0.612%"},
+            {"Sharpe Ratio", "-0.533"},
+            {"Sortino Ratio", "-2.937"},
+            {"Probabilistic Sharpe Ratio", "43.543%"},
+            {"Loss Rate", "50%"},
+            {"Win Rate", "50%"},
+            {"Profit-Loss Ratio", "59.94"},
+            {"Alpha", "-3.337"},
+            {"Beta", "0.465"},
+            {"Annual Standard Deviation", "0.033"},
+            {"Annual Variance", "0.001"},
+            {"Information Ratio", "-191.859"},
+            {"Tracking Error", "0.037"},
+            {"Treynor Ratio", "-0.037"},
+            {"Total Fees", "$0.00"},
+            {"Estimated Strategy Capacity", "$2800000.00"},
+            {"Lowest Capacity Asset", "SPXW XKZ5O96YJI3Y|SPX 31"},
+            {"Portfolio Turnover", "0.35%"},
+            {"Drawdown Recovery", "0"},
+            {"OrderListHash", "6d3578ad120bcbbe1fc4ed6d189cdd0d"}
+        };
+    }
+}