/* * 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.Util; using QuantConnect.Orders; using QuantConnect.Benchmarks; using QuantConnect.Securities; using QuantConnect.Orders.Fees; using System.Collections.Generic; namespace QuantConnect.Brokerages { /// /// Provides Binance specific properties /// public class BinanceBrokerageModel : DefaultBrokerageModel { private const decimal _defaultLeverage = 3; private const decimal _defaultFutureLeverage = 25; /// /// The base Binance API endpoint URL. /// protected virtual string BaseApiEndpoint => "https://api.binance.com/api/v3"; /// /// Market name /// protected virtual string MarketName => Market.Binance; /// /// Gets a map of the default markets to be used for each security type /// public override IReadOnlyDictionary DefaultMarkets { get; } = GetDefaultMarkets(Market.Binance); /// /// Initializes a new instance of the class /// /// The type of account to be modeled, defaults to public BinanceBrokerageModel(AccountType accountType = AccountType.Cash) : base(accountType) { } /// /// Binance global leverage rule /// /// /// public override decimal GetLeverage(Security security) { if (AccountType == AccountType.Cash || security.IsInternalFeed() || security.Type == SecurityType.Base) { return 1m; } return security.Symbol.SecurityType == SecurityType.CryptoFuture ? _defaultFutureLeverage : _defaultLeverage; } /// /// Get the benchmark for this model /// /// SecurityService to create the security with if needed /// The benchmark for this brokerage public override IBenchmark GetBenchmark(SecurityManager securities) { var symbol = Symbol.Create("BTCUSDC", SecurityType.Crypto, MarketName); return SecurityBenchmark.CreateInstance(securities, symbol); } /// /// Provides Binance fee model /// /// /// public override IFeeModel GetFeeModel(Security security) { return new BinanceFeeModel(); } /// /// Binance does not support update of orders /// /// The security of the order /// The order to be updated /// The requested update to be made to the order /// If this function returns false, a brokerage message detailing why the order may not be updated /// Binance does not support update of orders, so it will always return false public override bool CanUpdateOrder(Security security, Order order, UpdateOrderRequest request, out BrokerageMessageEvent message) { message = new BrokerageMessageEvent(BrokerageMessageType.Warning, 0, Messages.DefaultBrokerageModel.OrderUpdateNotSupported); return false; } /// /// Returns true if the brokerage could accept this order. This takes into account /// order type, security type, and order size limits. /// /// /// For example, a brokerage may have no connectivity at certain times, or an order rate/size limit /// /// The security of the order /// The order to be processed /// If this function returns false, a brokerage message detailing why the order may not be submitted /// True if the brokerage could process the order, false otherwise public override bool CanSubmitOrder(Security security, Order order, out BrokerageMessageEvent message) { message = null; // Binance API provides minimum order size in quote currency // and hence we have to check current order size using available price and order quantity var quantityIsValid = true; decimal price; switch (order) { case LimitOrder limitOrder: quantityIsValid &= IsOrderSizeLargeEnough(limitOrder.LimitPrice); price = limitOrder.LimitPrice; break; case MarketOrder: if (!security.HasData) { message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.NoDataForSymbol); return false; } price = order.Direction == OrderDirection.Buy ? security.AskPrice : security.BidPrice; quantityIsValid &= IsOrderSizeLargeEnough(price); break; case StopLimitOrder stopLimitOrder: price = stopLimitOrder.LimitPrice; quantityIsValid &= IsOrderSizeLargeEnough(stopLimitOrder.LimitPrice); if (!quantityIsValid) { break; } // Binance Trading UI requires this check too... quantityIsValid &= IsOrderSizeLargeEnough(stopLimitOrder.StopPrice); price = stopLimitOrder.StopPrice; break; case StopMarketOrder stopMarketOrder: if (security.Symbol.SecurityType != SecurityType.CryptoFuture) { // despite Binance API allows you to post STOP_LOSS and TAKE_PROFIT order types // they always fails with the content // {"code":-1013,"msg":"Take profit orders are not supported for this symbol."} // currently no symbols supporting TAKE_PROFIT or STOP_LOSS orders message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.BinanceBrokerageModel.UnsupportedOrderTypeWithLinkToSupportedTypes(BaseApiEndpoint, order, security)); return false; } quantityIsValid &= IsOrderSizeLargeEnough(stopMarketOrder.StopPrice); price = stopMarketOrder.StopPrice; break; default: message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.UnsupportedOrderType(this, order, new[] { OrderType.StopMarket, OrderType.StopLimit, OrderType.Market, OrderType.Limit })); return false; } if (!quantityIsValid) { message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.InvalidOrderSize(security, order.Quantity, price)); return false; } if (security.Type != SecurityType.Crypto && security.Type != SecurityType.CryptoFuture) { message = new BrokerageMessageEvent(BrokerageMessageType.Warning, "NotSupported", Messages.DefaultBrokerageModel.UnsupportedSecurityType(this, security)); return false; } return base.CanSubmitOrder(security, order, out message); bool IsOrderSizeLargeEnough(decimal price) => // if we have a minimum order size we enforce it !security.SymbolProperties.MinimumOrderSize.HasValue || order.AbsoluteQuantity * price > security.SymbolProperties.MinimumOrderSize; } /// /// Returns a readonly dictionary of binance default markets /// protected static IReadOnlyDictionary GetDefaultMarkets(string marketName) { var map = DefaultMarketMap.ToDictionary(); map[SecurityType.Crypto] = marketName; return map.ToReadOnlyDictionary(); } } }