Lean  $LEAN_TAG$
ModifiedFillQuantityOrderFee.cs
1 /*
2  * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
3  * Lean Algorithmic Trading Engine v2.0. Copyright 2014 QuantConnect Corporation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14 */
15 
17 
19 {
20  /// <summary>
21  /// An order fee where the fee quantity has already been subtracted from the filled quantity so instead we subtracted
22  /// from the quote currency when applied to the portfolio
23  /// </summary>
24  /// <remarks>
25  /// This type of order fee is returned by some crypto brokerages (e.g. Bitfinex and Binance)
26  /// with buy orders with cash accounts.
27  /// </remarks>
29  {
30  private readonly string _quoteCurrency;
31  private readonly decimal _contractMultiplier;
32 
33  /// <summary>
34  /// Initializes a new instance of the <see cref="ModifiedFillQuantityOrderFee"/> class
35  /// </summary>
36  /// <param name="orderFee">The order fee</param>
37  /// <param name="quoteCurrency">The associated security quote currency</param>
38  /// <param name="contractMultiplier">The associated security contract multiplier</param>
39  public ModifiedFillQuantityOrderFee(CashAmount orderFee, string quoteCurrency, decimal contractMultiplier)
40  : base(orderFee)
41  {
42  _quoteCurrency = quoteCurrency;
43  _contractMultiplier = contractMultiplier;
44  }
45 
46  /// <summary>
47  /// Applies the order fee to the given portfolio
48  /// </summary>
49  /// <param name="portfolio">The portfolio instance</param>
50  /// <param name="fill">The order fill event</param>
51  public override void ApplyToPortfolio(SecurityPortfolioManager portfolio, OrderEvent fill)
52  {
53  portfolio.CashBook[_quoteCurrency].AddAmount(-Value.Amount * fill.FillPrice * _contractMultiplier);
54  }
55  }
56 }