Provides an implementation of IBuyingPowerModel that uses an absurdly low margin requirement to ensure all orders have sufficient margin provided the portfolio is not underwater. More...

Inheritance diagram for QuantConnect.Securities.ConstantBuyingPowerModel:

[legend]

Public Member Functions
	ConstantBuyingPowerModel (decimal marginRequiredPerUnitInAccountCurrency)
	Initializes a new instance of the ConstantBuyingPowerModel class More...

override void	SetLeverage (Security security, decimal leverage)
	Sets the leverage for the applicable securities, i.e, equities More...

override InitialMargin	GetInitialMarginRequirement (InitialMarginParameters parameters)
	The margin that must be held in order to increase the position by the provided quantity More...

override MaintenanceMargin	GetMaintenanceMargin (MaintenanceMarginParameters parameters)
	Gets the margin currently allocated to the specified holding More...

Public Member Functions inherited from QuantConnect.Securities.BuyingPowerModel
	BuyingPowerModel ()
	Initializes a new instance of the BuyingPowerModel with no leverage (1x) More...

	BuyingPowerModel (decimal initialMarginRequirement, decimal maintenanceMarginRequirement, decimal requiredFreeBuyingPowerPercent)
	Initializes a new instance of the BuyingPowerModel More...

	BuyingPowerModel (decimal leverage, decimal requiredFreeBuyingPowerPercent=0)
	Initializes a new instance of the BuyingPowerModel More...

virtual decimal	GetLeverage (Security security)
	Gets the current leverage of the security More...

virtual InitialMargin	GetInitialMarginRequiredForOrder (InitialMarginRequiredForOrderParameters parameters)
	Gets the total margin required to execute the specified order in units of the account currency including fees More...

virtual HasSufficientBuyingPowerForOrderResult	HasSufficientBuyingPowerForOrder (HasSufficientBuyingPowerForOrderParameters parameters)
	Check if there is sufficient buying power to execute this order. More...

virtual GetMaximumOrderQuantityResult	GetMaximumOrderQuantityForDeltaBuyingPower (GetMaximumOrderQuantityForDeltaBuyingPowerParameters parameters)
	Get the maximum market order quantity to obtain a delta in the buying power used by a security. The deltas sign defines the position side to apply it to, positive long, negative short. More...

virtual GetMaximumOrderQuantityResult	GetMaximumOrderQuantityForTargetBuyingPower (GetMaximumOrderQuantityForTargetBuyingPowerParameters parameters)
	Get the maximum market order quantity to obtain a position with a given buying power percentage. Will not take into account free buying power. More...

decimal	GetAmountToOrder ([NotNull]Security security, decimal targetMargin, decimal marginForOneUnit, out decimal finalMargin)
	Helper function that determines the amount to order to get to a given target safely. Meaning it will either be at or just below target always. More...

virtual ReservedBuyingPowerForPosition	GetReservedBuyingPowerForPosition (ReservedBuyingPowerForPositionParameters parameters)
	Gets the amount of buying power reserved to maintain the specified position More...

virtual BuyingPower	GetBuyingPower (BuyingPowerParameters parameters)
	Gets the buying power available for a trade More...

Additional Inherited Members
Static Public Attributes inherited from QuantConnect.Securities.BuyingPowerModel
static readonly IBuyingPowerModel	Null = new NullBuyingPowerModel()
	Gets an implementation of IBuyingPowerModel that does not check for sufficient buying power More...

Protected Member Functions inherited from QuantConnect.Securities.BuyingPowerModel
virtual decimal	GetMarginRemaining (SecurityPortfolioManager portfolio, Security security, OrderDirection direction)
	Gets the margin cash available for a trade More...

Protected Attributes inherited from QuantConnect.Securities.BuyingPowerModel
decimal	RequiredFreeBuyingPowerPercent
	The percentage used to determine the required unused buying power for the account. More...

Detailed Description

Provides an implementation of IBuyingPowerModel that uses an absurdly low margin requirement to ensure all orders have sufficient margin provided the portfolio is not underwater.

Definition at line 22 of file ConstantBuyingPowerModel.cs.

Constructor & Destructor Documentation

◆ ConstantBuyingPowerModel()

QuantConnect.Securities.ConstantBuyingPowerModel.ConstantBuyingPowerModel ( decimal marginRequiredPerUnitInAccountCurrency )

Initializes a new instance of the ConstantBuyingPowerModel class

Parameters

marginRequiredPerUnitInAccountCurrency The constant amount of margin required per single unit of an asset. Each unit is defined as a quantity of 1 and NOT based on the lot size.

Definition at line 31 of file ConstantBuyingPowerModel.cs.

Member Function Documentation

◆ SetLeverage()

override void QuantConnect.Securities.ConstantBuyingPowerModel.SetLeverage	(	Security	security,
		decimal	leverage
	)

virtual

Sets the leverage for the applicable securities, i.e, equities

This is added to maintain backwards compatibility with the old margin/leverage system

Parameters

security
leverage	The new leverage

Reimplemented from QuantConnect.Securities.BuyingPowerModel.

Definition at line 45 of file ConstantBuyingPowerModel.cs.

◆ GetInitialMarginRequirement()

override InitialMargin QuantConnect.Securities.ConstantBuyingPowerModel.GetInitialMarginRequirement ( InitialMarginParameters parameters )

virtual

The margin that must be held in order to increase the position by the provided quantity

Parameters

parameters An object containing the security and quantity of shares

Returns: The initial margin required for the provided security and quantity

Reimplemented from QuantConnect.Securities.BuyingPowerModel.

Definition at line 57 of file ConstantBuyingPowerModel.cs.

◆ GetMaintenanceMargin()

override MaintenanceMargin QuantConnect.Securities.ConstantBuyingPowerModel.GetMaintenanceMargin ( MaintenanceMarginParameters parameters )

virtual

Gets the margin currently allocated to the specified holding

Parameters

parameters An object containing the security

Returns: The maintenance margin required for the provided holdings quantity/cost/value

Reimplemented from QuantConnect.Securities.BuyingPowerModel.

Definition at line 67 of file ConstantBuyingPowerModel.cs.

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

Common/Securities/ConstantBuyingPowerModel.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ConstantBuyingPowerModel()

Member Function Documentation

◆ SetLeverage()

◆ GetInitialMarginRequirement()

◆ GetMaintenanceMargin()