/*
* 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.Collections.Generic;
using QuantConnect.Data;
using QuantConnect.Interfaces;
using QuantConnect.Orders;
namespace QuantConnect.Algorithm.CSharp
{
///
/// This regression test is a version of
/// where we test market-on-close modeling with data from the post market.
///
public class MarketOnCloseOrderBufferExtendedMarketHoursRegressionAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
{
private OrderTicket _validOrderTicket;
private OrderTicket _invalidOrderTicket;
private OrderTicket _validOrderTicketAtMidnight;
private OrderTicket _validOrderTicketExtendedMarketHours;
public override void Initialize()
{
SetStartDate(2013, 10, 7); //Set Start Date
SetEndDate(2013, 10, 8); //Set End Date
var ticker = "SPY";
AddEquity(ticker, Resolution.Minute, extendedMarketHours: true);
Schedule.On(DateRules.Tomorrow, TimeRules.Midnight, () =>
{
_validOrderTicketAtMidnight = MarketOnCloseOrder("SPY", 2);
});
// Modify our submission buffer time to 10 minutes
Orders.MarketOnCloseOrder.SubmissionTimeBuffer = TimeSpan.FromMinutes(10);
}
public override void OnData(Slice slice)
{
// Test our ability to submit MarketOnCloseOrders
// Because we set our buffer to 10 minutes, any order placed
// before 3:50PM should be accepted, any after marked invalid
if (Time.Hour == 15 && Time.Minute == 49 && _validOrderTicket == null)
{
// Will not throw an order error and execute
_validOrderTicket = MarketOnCloseOrder("SPY", 2);
}
if (Time.Hour == 15 && Time.Minute == 51 && _invalidOrderTicket == null)
{
// Will throw an order error and be marked invalid
_invalidOrderTicket = MarketOnCloseOrder("SPY", 2);
}
if (Time.Hour == 16 && Time.Minute == 48 && _validOrderTicketExtendedMarketHours == null)
{
// Will not throw an order error and execute
_validOrderTicketExtendedMarketHours = MarketOnCloseOrder("SPY", 2);
}
}
public override void OnEndOfAlgorithm()
{
// Set it back to default for other regressions
Orders.MarketOnCloseOrder.SubmissionTimeBuffer = Orders.MarketOnCloseOrder.DefaultSubmissionTimeBuffer;
// Verify that our good order filled
if (_validOrderTicket.Status != OrderStatus.Filled)
{
throw new RegressionTestException("Valid order failed to fill");
}
// Verify our order was marked invalid
if (_invalidOrderTicket.Status != OrderStatus.Invalid)
{
throw new RegressionTestException("Invalid order was not rejected");
}
// Verify that our second good order filled
if (_validOrderTicketExtendedMarketHours.Status != OrderStatus.Filled)
{
throw new RegressionTestException("Valid order during extended market hours failed to fill");
}
// Verify that our third good order filled
if (_validOrderTicketAtMidnight.Status != OrderStatus.Filled)
{
throw new RegressionTestException("Valid order at midnight failed to fill");
}
}
///
/// This is used by the regression test system to indicate if the open source Lean repository has the required data to run this algorithm.
///
public bool CanRunLocally { get; } = true;
///
/// This is used by the regression test system to indicate which languages this algorithm is written in.
///
public List Languages { get; } = new() { Language.CSharp, Language.Python };
///
/// Data Points count of all timeslices of algorithm
///
public long DataPoints => 3862;
///
/// Data Points count of the algorithm history
///
public 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 Dictionary ExpectedStatistics => new()
{
{"Total Orders", "3"},
{"Average Win", "0%"},
{"Average Loss", "0%"},
{"Compounding Annual Return", "0%"},
{"Drawdown", "0%"},
{"Expectancy", "0"},
{"Start Equity", "100000"},
{"End Equity", "99996.08"},
{"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", "$3.00"},
{"Estimated Strategy Capacity", "$910000000.00"},
{"Lowest Capacity Asset", "SPY R735QTJ8XC9X"},
{"Portfolio Turnover", "0.43%"},
{"Drawdown Recovery", "0"},
{"OrderListHash", "df8ee16902d30659c4b1411075e9fc23"}
};
}
}