Supported Models

Wolverine

Introduction

This page explains the WolverineBrokerageModel, including the asset classes it supports, its default security-level models, and its default markets.

SetBrokerageModel(BrokerageName.Wolverine, AccountType.Cash);
SetBrokerageModel(BrokerageName.Wolverine, AccountType.Margin);
self.set_brokerage_model(BrokerageName.WOLVERINE, AccountType.CASH)
self.set_brokerage_model(BrokerageName.WOLVERINE, AccountType.MARGIN)

For more information about this model, see the class reference and implementation.

For more information about this model, see the class reference and implementation.

Asset Classes

The WolverineBrokerageModel supports trading US Equities.

Orders

The WolverineBrokerageModel supports one order type, but doesn't support order updates or extended market hours trading.

Order Types

The following table describes the available order types for each asset class that the WolverineBrokerageModel supports:

Order TypeEquity
Marketgreen check
Market on Closegreen check
Limitgreen check
Stop marketgreen check
Stop limitgreen check

Updates

The WolverineBrokerageModel doesn't support order updates.

Extended Market Hours

The WolverineBrokerageModel doesn't support extended market hours trading. If you place an order outside of regular trading hours, the order is invalid.

Order Properties

The WolverineBrokerageModel supports custom order properties. The following table describes the members of the WolverineOrderProperties object that you can set to customize order execution:

PropertyDescription
TimeInForcetime_in_forceTimeInForceA TimeInForce instruction to apply to the order. The following instructions are supported:
  • DayDAY
  • GoodTilCanceledGOOD_TIL_CANCELED
TimeInForce.GoodTilCanceledTimeInForce.GOOD_TIL_CANCELED
ExchangeexchangeExchangeDefines the exchange name for a particular market. For example, Exchange.SMART.
ExchangePostFixexchange_post_fixstringstrThe exchange post fix to apply if any. For example, if you set Exchangeexchange to Exchange.SMART, then "-INCA-TX" yields "SMART-INCA-TX".
LocateBrokerlocate_brokerstringstrIdentifies the broker source for borrowed stock.
PositionSideposition_sideOrderPosition?OrderPosition | NoneTypeSpecify the position side in the order direction (buy-to-open, sell-to-close, etc.) instead of the default handlingnullNone
 
public override void Initialize()
{
    // Set the default order properties
    DefaultOrderProperties = new WolverineOrderProperties
    {
        TimeInForce = TimeInForce.GoodTilCanceled,
        Exchange = Exchange.SMART,
        ExchangePostFix = "-INCA-TX",
        OrderPosition = OrderPosition.BuyToOpen,
        // Optionally, you can specify for equity shorts which broker will provide the stock to short
        // if not specified defaults to broker will provide
        LocateBroker = "abn"
    };
}
def initialize(self) -> None:
    # Set the default order properties
    self.default_order_properties = WolverineOrderProperties()
    self.default_order_properties.time_in_force = TimeInForce.GOOD_TIL_CANCELED
    self.default_order_properties.exchange = Exchange.SMART
    self.default_order_properties.exchange_post_fix = "-INCA-TX"
    self.default_order_properties.order_position = OrderPosition.BUY_TO_OPEN
    # Optionally, you can specify for equity shorts which broker will provide the stock to short
    # if not specified defaults to broker will provide
    self.default_order_properties.locate_broker = "abn"

If the PositionSideposition_side is not specified, the engine will determine it from the holdings and the order quantity. For example, if it's a sell short and will send PositionSideSellShortSELL_SHORT.

Fills

The WolverineBrokerageModel uses the EquityFillModel for Equity trades.

Slippage

The WolverineBrokerageModel uses the NullSlippageModel.

Fees

The WolverineBrokerageModel uses the WolverineFeeModel.

Buying Power

The WolverineBrokerageModel uses the SecurityMarginModel. If you have a margin account, the WolverineBrokerageModel allows up to 2x leverage.

Settlement

The WolverineBrokerageModel uses the ImmediateSettlementModel for margin accounts and the DelayedSettlementModel with the default settlement rules for cash accounts.

// For cash accounts:
security.SetSettlementModel(new DelayedSettlementModel(Equity.DefaultSettlementDays, Equity.DefaultSettlementTime));

// For margin accounts:
security.SetSettlementModel(new ImmediateSettlementModel());
# For cash accounts:
security.set_settlement_model(DelayedSettlementModel(Equity.DEFAULT_SETTLEMENT_DAYS, Equity.DEFAULT_SETTLEMENT_TIME))

# For margin accounts:
security.set_settlement_model(ImmediateSettlementModel())

Margin Interest Rate

The WolverineBrokerageModel uses the NullMarginInterestRateModel.

Default Markets

The default market of the WolverineBrokerageModel is Market.USA.

Account Currency

The WolverineBrokerageModel doesn't set a default currency. To change the algorithm's currency from USD to a different currency, see Set Account Currency.

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: