Lean  $LEAN_TAG$
QuantConnect.Brokerages.TradierBrokerageModel Class Reference

Provides tradier specific properties More...

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

Public Member Functions

 TradierBrokerageModel (AccountType accountType=AccountType.Margin)
 Initializes a new instance of the DefaultBrokerageModel class 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...
 
override bool CanUpdateOrder (Security security, Order order, UpdateOrderRequest request, out BrokerageMessageEvent message)
 Returns true if the brokerage would allow updating the order as specified by the request More...
 
override 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...
 
override void ApplySplit (List< OrderTicket > tickets, Split split)
 Applies the split to the specified order ticket More...
 
override IFeeModel GetFeeModel (Security security)
 Gets a new fee model that represents this brokerage's fee structure More...
 
- Public Member Functions inherited from QuantConnect.Brokerages.DefaultBrokerageModel
 DefaultBrokerageModel (AccountType accountType=AccountType.Margin)
 Initializes a new instance of the DefaultBrokerageModel class More...
 
virtual decimal GetLeverage (Security security)
 Gets the brokerage's leverage for the specified security More...
 
virtual IBenchmark GetBenchmark (SecurityManager securities)
 Get the benchmark for this model 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...
 

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...
 
- 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...
 

Detailed Description

Provides tradier specific properties

Definition at line 30 of file TradierBrokerageModel.cs.

Constructor & Destructor Documentation

◆ TradierBrokerageModel()

QuantConnect.Brokerages.TradierBrokerageModel.TradierBrokerageModel ( AccountType  accountType = AccountType.Margin)

Initializes a new instance of the DefaultBrokerageModel class

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

Definition at line 45 of file TradierBrokerageModel.cs.

Member Function Documentation

◆ CanSubmitOrder()

override bool QuantConnect.Brokerages.TradierBrokerageModel.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 61 of file TradierBrokerageModel.cs.

Here is the call graph for this function:

◆ CanUpdateOrder()

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

Returns true if the brokerage would allow updating the order as specified by the request

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
True if the brokerage would allow updating the order, false otherwise

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 131 of file TradierBrokerageModel.cs.

◆ CanExecuteOrder()

override bool QuantConnect.Brokerages.TradierBrokerageModel.CanExecuteOrder ( Security  security,
Order  order 
)
virtual

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.

Parameters
securityThe security being ordered
orderThe order to test for execution
Returns
True if the brokerage would be able to perform the execution, false otherwise

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 157 of file TradierBrokerageModel.cs.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ApplySplit()

override void QuantConnect.Brokerages.TradierBrokerageModel.ApplySplit ( List< OrderTicket tickets,
Split  split 
)
virtual

Applies the split to the specified order ticket

Parameters
ticketsThe open tickets matching the split event
splitThe split event data

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 178 of file TradierBrokerageModel.cs.

◆ GetFeeModel()

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

Gets a new fee model that represents this brokerage's fee structure

Parameters
securityThe security to get a fee model for
Returns
The new fee model for this brokerage

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 197 of file TradierBrokerageModel.cs.


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