Lean  $LEAN_TAG$
QuantConnect.Brokerages.BinanceBrokerageModel Class Reference

Provides Binance specific properties More...

Inheritance diagram for QuantConnect.Brokerages.BinanceBrokerageModel:
[legend]

Public Member Functions

 BinanceBrokerageModel (AccountType accountType=AccountType.Cash)
 Initializes a new instance of the BinanceBrokerageModel class More...
 
override decimal GetLeverage (Security security)
 Binance global leverage rule More...
 
override IBenchmark GetBenchmark (SecurityManager securities)
 Get the benchmark for this model More...
 
override IFeeModel GetFeeModel (Security security)
 Provides Binance fee model More...
 
override bool CanUpdateOrder (Security security, Order order, UpdateOrderRequest request, out BrokerageMessageEvent message)
 Binance does not support update of orders More...
 
override bool CanSubmitOrder (Security security, Order order, out BrokerageMessageEvent message)
 Returns true if the brokerage could accept this order. This takes into account order type, security type, and order size limits. More...
 
- Public Member Functions inherited from QuantConnect.Brokerages.DefaultBrokerageModel
 DefaultBrokerageModel (AccountType accountType=AccountType.Margin)
 Initializes a new instance of the DefaultBrokerageModel class More...
 
virtual bool CanExecuteOrder (Security security, Order order)
 Returns true if the brokerage would be able to execute this order at this time assuming market prices are sufficient for the fill to take place. This is used to emulate the brokerage fills in backtesting and paper trading. For example some brokerages may not perform executions during extended market hours. This is not intended to be checking whether or not the exchange is open, that is handled in the Security.Exchange property. More...
 
virtual void ApplySplit (List< OrderTicket > tickets, Split split)
 Applies the split to the specified order ticket More...
 
virtual IFillModel GetFillModel (Security security)
 Gets a new fill model that represents this brokerage's fill behavior More...
 
virtual ISlippageModel GetSlippageModel (Security security)
 Gets a new slippage model that represents this brokerage's fill slippage behavior More...
 
virtual ISettlementModel GetSettlementModel (Security security)
 Gets a new settlement model for the security More...
 
ISettlementModel GetSettlementModel (Security security, AccountType accountType)
 Gets a new settlement model for the security More...
 
virtual IBuyingPowerModel GetBuyingPowerModel (Security security)
 Gets a new buying power model for the security, returning the default model with the security's configured leverage. For cash accounts, leverage = 1 is used. More...
 
virtual IShortableProvider GetShortableProvider (Security security)
 Gets the shortable provider More...
 
virtual IMarginInterestRateModel GetMarginInterestRateModel (Security security)
 Gets a new margin interest rate model for the security More...
 
IBuyingPowerModel GetBuyingPowerModel (Security security, AccountType accountType)
 Gets a new buying power model for the security More...
 

Static Protected Member Functions

static IReadOnlyDictionary< SecurityType, string > GetDefaultMarkets (string marketName)
 Returns a readonly dictionary of binance default markets More...
 

Protected Attributes

virtual string BaseApiEndpoint => "https://api.binance.com/api/v3"
 The base Binance API endpoint URL. More...
 
virtual string MarketName => Market.Binance
 Market name More...
 

Properties

override IReadOnlyDictionary< SecurityType, string > DefaultMarkets = GetDefaultMarkets(Market.Binance) [get]
 Gets a map of the default markets to be used for each security type More...
 
- Properties inherited from QuantConnect.Brokerages.DefaultBrokerageModel
virtual AccountType AccountType [get]
 Gets or sets the account type used by this model More...
 
virtual IReadOnlyDictionary< SecurityType, string > DefaultMarkets [get]
 Gets a map of the default markets to be used for each security type More...
 
- Properties inherited from QuantConnect.Brokerages.IBrokerageModel
AccountType AccountType [get]
 Gets the account type used by this model More...
 
decimal RequiredFreeBuyingPowerPercent [get]
 Gets the brokerages model percentage factor used to determine the required unused buying power for the account. From 1 to 0. Example: 0 means no unused buying power is required. 0.5 means 50% of the buying power should be left unused. More...
 
IReadOnlyDictionary< SecurityType, string > DefaultMarkets [get]
 Gets a map of the default markets to be used for each security type More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QuantConnect.Brokerages.DefaultBrokerageModel
static bool IsValidOrderSize (Security security, decimal orderQuantity, out BrokerageMessageEvent message)
 Checks if the order quantity is valid, it means, the order size is bigger than the minimum size allowed More...
 
- Public Attributes inherited from QuantConnect.Brokerages.DefaultBrokerageModel
virtual decimal RequiredFreeBuyingPowerPercent => 0m
 Gets the brokerages model percentage factor used to determine the required unused buying power for the account. From 1 to 0. Example: 0 means no unused buying power is required. 0.5 means 50% of the buying power should be left unused. More...
 
- Static Public Attributes inherited from QuantConnect.Brokerages.DefaultBrokerageModel
static readonly IReadOnlyDictionary< SecurityType, string > DefaultMarketMap
 The default markets for the backtesting brokerage More...
 

Detailed Description

Provides Binance specific properties

Definition at line 29 of file BinanceBrokerageModel.cs.

Constructor & Destructor Documentation

◆ BinanceBrokerageModel()

QuantConnect.Brokerages.BinanceBrokerageModel.BinanceBrokerageModel ( AccountType  accountType = AccountType.Cash)

Initializes a new instance of the BinanceBrokerageModel class

Parameters
accountTypeThe type of account to be modeled, defaults to AccountType.Cash

Definition at line 53 of file BinanceBrokerageModel.cs.

Member Function Documentation

◆ GetLeverage()

override decimal QuantConnect.Brokerages.BinanceBrokerageModel.GetLeverage ( Security  security)
virtual

Binance global leverage rule

Parameters
security
Returns

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Reimplemented in QuantConnect.Brokerages.BinanceUSBrokerageModel.

Definition at line 62 of file BinanceBrokerageModel.cs.

◆ GetBenchmark()

override IBenchmark QuantConnect.Brokerages.BinanceBrokerageModel.GetBenchmark ( SecurityManager  securities)
virtual

Get the benchmark for this model

Parameters
securitiesSecurityService to create the security with if needed
Returns
The benchmark for this brokerage

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Reimplemented in QuantConnect.Brokerages.BinanceFuturesBrokerageModel, and QuantConnect.Brokerages.BinanceCoinFuturesBrokerageModel.

Definition at line 77 of file BinanceBrokerageModel.cs.

Here is the call graph for this function:

◆ GetFeeModel()

override IFeeModel QuantConnect.Brokerages.BinanceBrokerageModel.GetFeeModel ( Security  security)
virtual

Provides Binance fee model

Parameters
security
Returns

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Reimplemented in QuantConnect.Brokerages.BinanceFuturesBrokerageModel, and QuantConnect.Brokerages.BinanceCoinFuturesBrokerageModel.

Definition at line 88 of file BinanceBrokerageModel.cs.

◆ CanUpdateOrder()

override bool QuantConnect.Brokerages.BinanceBrokerageModel.CanUpdateOrder ( Security  security,
Order  order,
UpdateOrderRequest  request,
out BrokerageMessageEvent  message 
)
virtual

Binance does not support update of orders

Parameters
securityThe security of the order
orderThe order to be updated
requestThe requested update to be made to the order
messageIf this function returns false, a brokerage message detailing why the order may not be updated
Returns
Binance does not support update of orders, so it will always return false

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 101 of file BinanceBrokerageModel.cs.

◆ CanSubmitOrder()

override bool QuantConnect.Brokerages.BinanceBrokerageModel.CanSubmitOrder ( Security  security,
Order  order,
out BrokerageMessageEvent  message 
)
virtual

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

Parameters
securityThe security of the order
orderThe order to be processed
messageIf this function returns false, a brokerage message detailing why the order may not be submitted
Returns
True if the brokerage could process the order, false otherwise

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 118 of file BinanceBrokerageModel.cs.

Here is the call graph for this function:

◆ GetDefaultMarkets()

static IReadOnlyDictionary<SecurityType, string> QuantConnect.Brokerages.BinanceBrokerageModel.GetDefaultMarkets ( string  marketName)
staticprotected

Returns a readonly dictionary of binance default markets

Definition at line 209 of file BinanceBrokerageModel.cs.

Member Data Documentation

◆ BaseApiEndpoint

virtual string QuantConnect.Brokerages.BinanceBrokerageModel.BaseApiEndpoint => "https://api.binance.com/api/v3"
protected

The base Binance API endpoint URL.

Definition at line 37 of file BinanceBrokerageModel.cs.

◆ MarketName

virtual string QuantConnect.Brokerages.BinanceBrokerageModel.MarketName => Market.Binance
protected

Market name

Definition at line 42 of file BinanceBrokerageModel.cs.

Property Documentation

◆ DefaultMarkets

override IReadOnlyDictionary<SecurityType, string> QuantConnect.Brokerages.BinanceBrokerageModel.DefaultMarkets = GetDefaultMarkets(Market.Binance)
get

Gets a map of the default markets to be used for each security type

Definition at line 47 of file BinanceBrokerageModel.cs.


The documentation for this class was generated from the following file: