/*
* 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.Orders;
using QuantConnect.Interfaces;
using QuantConnect.Securities;
using System.Collections.Generic;
using QuantConnect.Securities.Future;
namespace QuantConnect.Algorithm.CSharp
{
///
/// Regression algorithm asserting the futures daily cash settlement behavior taking long positions
///
public class FuturesDailySettlementLongRegressionAlgorithm : QCAlgorithm, IRegressionAlgorithmDefinition
{
private decimal _initialPortfolioValue;
private int _lastTradedDay;
private Symbol _contractSymbol;
private Future _future;
///
/// Expected cash balance for each day
///
protected virtual Dictionary ExpectedCash { get; } = new()
{
{ new DateTime(2013, 10, 07), 100000 },
{ new DateTime(2013, 10, 08), 103264.45m },
{ new DateTime(2013, 10, 09), 101231.05m },
{ new DateTime(2013, 10, 10), 101962.10m },
{ new DateTime(2013, 10, 10, 17, 0, 0), 100905.65m }
};
///
/// Order side factor
///
protected virtual int OrderSide => 1;
///
/// Initialize your algorithm and add desired assets.
///
public override void Initialize()
{
SetStartDate(2013, 10, 07);
SetEndDate(2013, 10, 10);
var future = QuantConnect.Symbol.Create(Futures.Indices.SP500EMini, SecurityType.Future, Market.CME);
_contractSymbol = FuturesChain(future).OrderBy(x => x.ID.Date).First();
_future = AddFutureContract(_contractSymbol);
_future.Holdings.SetHoldings(1600, 1 * OrderSide);
}
///
/// Event - v3.0 DATA EVENT HANDLER: (Pattern) Basic template for user to override for receiving all subscription data in a single event
///
/// The current slice of data keyed by symbol string
public override void OnData(Slice slice)
{
AssertCash(Time.Date);
if (Transactions.OrdersCount == 0)
{
// initial trade
_initialPortfolioValue = Portfolio.TotalPortfolioValue - _future.Holdings.UnrealizedProfit;
MarketOrder(_contractSymbol, 1 * OrderSide);
}
else if(Time.Day == 7 && _lastTradedDay != Time.Day)
{
_lastTradedDay = Time.Day;
// increase position
MarketOrder(_contractSymbol, 1 * OrderSide);
}
else if (Time.Day == 8 && _lastTradedDay != Time.Day)
{
_lastTradedDay = Time.Day;
// reduce position
MarketOrder(_contractSymbol, -1 * OrderSide);
}
else if (Time.Day == 9 && _lastTradedDay != Time.Day)
{
_lastTradedDay = Time.Day;
// cross position
MarketOrder(_contractSymbol, -3 * OrderSide);
}
else if (Time.Day == 10)
{
if(_lastTradedDay != Time.Day)
{
_lastTradedDay = Time.Day;
// increase position
MarketOrder(_contractSymbol, -1 * OrderSide);
}
else
{
// finally liquidate
Liquidate();
}
}
}
private void AssertCash(DateTime currentTime)
{
if (ExpectedCash.Remove(currentTime, out var expected))
{
var value = Portfolio.CashBook.TotalValueInAccountCurrency;
if (expected != Math.Round(value, 5))
{
throw new RegressionTestException($"Unexpected cash balance {value} expected {expected}");
}
}
}
public override void OnOrderEvent(OrderEvent orderEvent)
{
if (orderEvent.Status.IsFill())
{
Debug($"{orderEvent}");
}
}
public override void OnEndOfAlgorithm()
{
var holdings = (FutureHolding)_future.Holdings;
Debug($"{Environment.NewLine}InitialPortfolioValue: {_initialPortfolioValue}. CurrentPortfolioValue: {Portfolio.TotalPortfolioValue}" +
$"{Environment.NewLine}Profit: {holdings.Profit}" +
$"{Environment.NewLine}Fees: {holdings.TotalFees}" +
$"{Environment.NewLine}CashBook:{Environment.NewLine}{Portfolio.CashBook}" +
$"{Environment.NewLine}UnsettledCashBook:{Environment.NewLine}{Portfolio.UnsettledCashBook}");
var expected = _initialPortfolioValue + holdings.NetProfit;
if (expected != Portfolio.TotalPortfolioValue || expected != Portfolio.CashBook[Currencies.USD].Amount)
{
throw new RegressionTestException($"Unexpected future profit {holdings.NetProfit}");
}
if(holdings.SettledProfit != 0)
{
throw new RegressionTestException($"Unexpected SettledProfit value {holdings.SettledProfit}");
}
if (holdings.UnrealizedProfit != 0)
{
throw new RegressionTestException($"Unexpected UnrealizedProfit value {holdings.UnrealizedProfit}");
}
AssertCash(Time);
}
///
/// 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 };
///
/// Data Points count of all timeslices of algorithm
///
public long DataPoints => 5444;
///
/// Data Points count of the algorithm history
///
public int AlgorithmHistoryDataPoints => 1;
///
/// 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 virtual Dictionary ExpectedStatistics => new Dictionary
{
{"Total Orders", "6"},
{"Average Win", "0.89%"},
{"Average Loss", "-0.87%"},
{"Compounding Annual Return", "142.879%"},
{"Drawdown", "3.800%"},
{"Expectancy", "0.349"},
{"Start Equity", "100000"},
{"End Equity", "100905.65"},
{"Net Profit", "0.906%"},
{"Sharpe Ratio", "-3.968"},
{"Sortino Ratio", "-8.141"},
{"Probabilistic Sharpe Ratio", "0%"},
{"Loss Rate", "33%"},
{"Win Rate", "67%"},
{"Profit-Loss Ratio", "1.02"},
{"Alpha", "-1.091"},
{"Beta", "0.151"},
{"Annual Standard Deviation", "0.216"},
{"Annual Variance", "0.047"},
{"Information Ratio", "-7.634"},
{"Tracking Error", "0.313"},
{"Treynor Ratio", "-5.675"},
{"Total Fees", "$19.35"},
{"Estimated Strategy Capacity", "$100000000.00"},
{"Lowest Capacity Asset", "ES VMKLFZIH2MTD"},
{"Portfolio Turnover", "183.82%"},
{"Drawdown Recovery", "0"},
{"OrderListHash", "0a1d9c87a1aced914c355e762c255a31"}
};
}
}