Skip to content

ApplyFundsSettlementModelParameters

QuantConnect.Securities.ApplyFundsSettlementModelParameters

ApplyFundsSettlementModelParameters(
    portfolio: SecurityPortfolioManager,
    security: Security,
    application_time_utc: Union[datetime, date],
    cash_amount: CashAmount,
    fill: OrderEvent,
)

Bases: Object

Helper parameters class for ISettlementModel.apply_funds(apply_fundsSettlementModelParameters)

Creates a new instance

Parameters:

Name Type Description Default
portfolio SecurityPortfolioManager

The algorithm's portfolio

required
security Security

The fill's security

required
application_time_utc Union[datetime, date]

The fill time (in UTC)

required
cash_amount CashAmount

The amount to settle

required
fill OrderEvent

The associated fill

required

portfolio

The algorithm portfolio instance

security

security: Security

The associated security type

utc_time

utc_time: datetime

The current Utc time

cash_amount

cash_amount: CashAmount

The funds to apply

fill

fill: OrderEvent

The associated fill event