Skip to content

ISettlementModel

QuantConnect.Securities.ISettlementModel

Represents the model responsible for applying cash settlement rules

apply_funds

apply_funds(
    apply_funds_parameters: ApplyFundsSettlementModelParameters,
) -> None

Applies cash settlement rules

Parameters:

Name Type Description Default
apply_funds_parameters ApplyFundsSettlementModelParameters

The funds application parameters

required

get_unsettled_cash

get_unsettled_cash() -> CashAmount

Gets the unsettled cash amount for the security

scan

scan(
    settlement_parameters: ScanSettlementModelParameters,
) -> None

Scan for pending settlements

Parameters:

Name Type Description Default
settlement_parameters ScanSettlementModelParameters

The settlement parameters

required