Settlement
Supported Models
Introduction
This page describes all of the pre-built settlement models in LEAN. For more brokerage-specific settlement models, see the brokerage model documentation. If none of these models perform exactly how you want, create a custom settlement model.
Immediate Model
The ImmediateSettlementModel immediately adds or removes the cash from your portfolio when your transactions fill.
security.SetSettlementModel(new ImmediateSettlementModel());
security.set_settlement_model(ImmediateSettlementModel())
For more information about this model, see the class reference and implementation.
For more information about this model, see the class reference and implementation.
Delayed Model
The DelayedSettlementModel immediately removes the cash from your portfolio when your buy orders fill. When your sell orders fill, it adds the cash to your unsettled cash book. When the settlement period ends, the unsettled cash is added to your portfolio.
security.SetSettlementModel(new DelayedSettlementModel(7, TimeSpan.FromHours(8)));
security.set_settlement_model(DelayedSettlementModel(7, timedelta(hours=8)))
The following table describes the arguments the model accepts:
| Argument | Data Type | Description | Default Value |
|---|---|---|---|
numberOfDaysnumber_of_days | int | The number of days required for settlement | |
timeOfDaytime_of_day | TimeSpantimedelta | The time of day used for settlement |
For more information about this model, see the class reference and implementation.
For more information about this model, see the class reference and implementation.
Account Currency Immediate Model
The AccountCurrencyImmediateSettlementModel applies cash settlement immediately and automatically converts the settlement cash into the account currency.
security.SetSettlementModel(new AccountCurrencyImmediateSettlementModel());
security.set_settlement_model(AccountCurrencyImmediateSettlementModel())
For more information about this model, see the class reference and implementation.
For more information about this model, see the class reference and implementation.
Future Model
The FutureSettlementModel settles the daily profit and loss at the start of each day.
security.SetSettlementModel(new FutureSettlementModel());
security.set_settlement_model(FutureSettlementModel())
For more information about this model, see the class reference and implementation.
For more information about this model, see the class reference and implementation.
You can also see our Videos. You can also get in touch with us via Discord.
Did you find this page helpful?
