FutureSettlementModel
QuantConnect.Securities.Future.FutureSettlementModel
Bases: ImmediateSettlementModel
Settlement model which can handle daily profit and loss settlement
apply_funds
apply_funds(
apply_funds_parameters: ApplyFundsSettlementModelParameters,
) -> None
Applies unsettledContractsTodaysProfit settlement rules
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
apply_funds_parameters
|
ApplyFundsSettlementModelParameters
|
The funds application parameters |
required |
scan
scan(
settlement_parameters: ScanSettlementModelParameters,
) -> None
Scan for pending settlements
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
settlement_parameters
|
ScanSettlementModelParameters
|
The settlement parameters |
required |
set_local_date_time_frontier
set_local_date_time_frontier(
new_local_time: Union[datetime, date],
) -> None
Set the current datetime in terms of the exchange's local time zone
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
new_local_time
|
Union[datetime, date]
|
Current local time |
required |
get_unsettled_cash
get_unsettled_cash() -> CashAmount
Gets the unsettled cash amount for the security