Provides properties specific to interactive brokers More...

Inheritance diagram for QuantConnect.Brokerages.InteractiveBrokersBrokerageModel:

Public Member Functions
	InteractiveBrokersBrokerageModel (AccountType accountType=AccountType.Margin)
	Initializes a new instance of the InteractiveBrokersBrokerageModel class More...

override IBenchmark	GetBenchmark (SecurityManager securities)
	Get the benchmark for this model More...

override IFeeModel	GetFeeModel (Security security)
	Gets a new fee model that represents this brokerage's fee structure More...

override decimal	GetLeverage (Security security)
	Gets the brokerage's leverage for the specified security 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...

Public Member Functions inherited from QuantConnect.Brokerages.DefaultBrokerageModel
	DefaultBrokerageModel (AccountType accountType=AccountType.Margin)
	Initializes a new instance of the DefaultBrokerageModel class 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...

Public Attributes
override IReadOnlyDictionary< SecurityType, string >	DefaultMarkets => DefaultMarketMap
	Gets a map of the default markets to be used for each security type 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
static new readonly IReadOnlyDictionary< SecurityType, string >	DefaultMarketMap
	The default markets for the IB brokerage More...

Static Public Attributes inherited from QuantConnect.Brokerages.DefaultBrokerageModel
static readonly IReadOnlyDictionary< SecurityType, string >	DefaultMarketMap
	The default markets for the backtesting brokerage 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...

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 properties specific to interactive brokers

Definition at line 33 of file InteractiveBrokersBrokerageModel.cs.

Constructor & Destructor Documentation

◆ InteractiveBrokersBrokerageModel()

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

Initializes a new instance of the InteractiveBrokersBrokerageModel class

Parameters

accountType The type of account to be modelled, defaults to AccountType.Margin

Definition at line 79 of file InteractiveBrokersBrokerageModel.cs.

Member Function Documentation

◆ GetBenchmark()

override IBenchmark QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.GetBenchmark ( SecurityManager securities )

virtual

Get the benchmark for this model

Parameters

securities SecurityService to create the security with if needed

Returns: The benchmark for this brokerage

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 94 of file InteractiveBrokersBrokerageModel.cs.

◆ GetFeeModel()

override IFeeModel QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.GetFeeModel ( Security security )

virtual

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

Parameters

security The security to get a fee model for

Returns: The new fee model for this brokerage

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 105 of file InteractiveBrokersBrokerageModel.cs.

◆ GetLeverage()

override decimal QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.GetLeverage ( Security security )

virtual

Gets the brokerage's leverage for the specified security

Parameters

security The security's whose leverage we seek

Returns: The leverage for the specified security

Reimplemented from QuantConnect.Brokerages.DefaultBrokerageModel.

Definition at line 115 of file InteractiveBrokersBrokerageModel.cs.

◆ CanSubmitOrder()

override bool QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.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

security	The security being ordered
order	The order to be processed
message	If 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 136 of file InteractiveBrokersBrokerageModel.cs.

Here is the call graph for this function:

◆ CanUpdateOrder()

override bool QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.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

security	The security of the order
order	The order to be updated
request	The requested update to be made to the order
message	If 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 216 of file InteractiveBrokersBrokerageModel.cs.

◆ CanExecuteOrder()

override bool QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.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

security
order	The 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 238 of file InteractiveBrokersBrokerageModel.cs.

Member Data Documentation

◆ DefaultMarketMap

new readonly IReadOnlyDictionary<SecurityType, string> QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.DefaultMarketMap

static

Initial value:

= new Dictionary<SecurityType, string>
        {
            {SecurityType.Base, Market.USA},
            {SecurityType.Equity, Market.USA},
            {SecurityType.Index, Market.USA},
            {SecurityType.Option, Market.USA},
            {SecurityType.IndexOption, Market.USA},
            {SecurityType.Future, Market.CME},
            {SecurityType.FutureOption, Market.CME},
            {SecurityType.Forex, Market.Oanda},
            {SecurityType.Cfd, Market.InteractiveBrokers}
        }.ToReadOnlyDictionary()

The default markets for the IB brokerage

Definition at line 38 of file InteractiveBrokersBrokerageModel.cs.

◆ DefaultMarkets

override IReadOnlyDictionary<SecurityType, string> QuantConnect.Brokerages.InteractiveBrokersBrokerageModel.DefaultMarkets => DefaultMarketMap

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

Definition at line 87 of file InteractiveBrokersBrokerageModel.cs.

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

Common/Brokerages/InteractiveBrokersBrokerageModel.cs

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InteractiveBrokersBrokerageModel()

Member Function Documentation

◆ GetBenchmark()

◆ GetFeeModel()

◆ GetLeverage()

◆ CanSubmitOrder()

◆ CanUpdateOrder()

◆ CanExecuteOrder()

Member Data Documentation

◆ DefaultMarketMap

◆ DefaultMarkets