Lean  $LEAN_TAG$
QuantConnect.Commands.AddSecurityCommand Class Reference

Represents a command to add a security to the algorithm More...

Inheritance diagram for QuantConnect.Commands.AddSecurityCommand:
[legend]

Classes

class  Result
 Result packet type for the AddSecurityCommand command More...
 

Public Member Functions

 AddSecurityCommand ()
 Default construct that applies default values More...
 
override CommandResultPacket Run (IAlgorithm algorithm)
 Runs this command against the specified algorithm instance More...
 

Properties

SecurityType SecurityType [get, set]
 The security type of the security More...
 
string Symbol [get, set]
 The security's ticker symbol More...
 
Resolution Resolution [get, set]
 The requested resolution, defaults to Resolution.Minute More...
 
string Market [get, set]
 The security's market, defaults to QuantConnect.Market.USA except for Forex, defaults to QuantConnect.Market.FXCM More...
 
bool FillDataForward [get, set]
 The fill forward behavior, true to fill forward, false otherwise - defaults to true More...
 
decimal Leverage [get, set]
 The leverage for the security, defaults to 2 for equity, 50 for forex, and 1 for everything else More...
 
bool ExtendedMarketHours [get, set]
 The extended market hours flag, true to allow pre/post market data, false for only in market data More...
 
- Properties inherited from QuantConnect.Commands.BaseCommand
string Id [get, set]
 Unique command id More...
 
- Properties inherited from QuantConnect.Commands.ICommand
string Id [get, set]
 Unique command id More...
 

Additional Inherited Members

- Protected Member Functions inherited from QuantConnect.Commands.BaseCommand
Symbol GetSymbol (string ticker, SecurityType securityType, string market, Symbol symbol=null)
 Creats symbol using symbol properties. More...
 

Detailed Description

Represents a command to add a security to the algorithm

Definition at line 24 of file AddSecurityCommand.cs.

Constructor & Destructor Documentation

◆ AddSecurityCommand()

QuantConnect.Commands.AddSecurityCommand.AddSecurityCommand ( )

Default construct that applies default values

Definition at line 64 of file AddSecurityCommand.cs.

Member Function Documentation

◆ Run()

override CommandResultPacket QuantConnect.Commands.AddSecurityCommand.Run ( IAlgorithm  algorithm)
virtual

Runs this command against the specified algorithm instance

Parameters
algorithmThe algorithm to run this command against

Implements QuantConnect.Commands.BaseCommand.

Definition at line 77 of file AddSecurityCommand.cs.

Here is the call graph for this function:

Property Documentation

◆ SecurityType

SecurityType QuantConnect.Commands.AddSecurityCommand.SecurityType
getset

The security type of the security

Definition at line 29 of file AddSecurityCommand.cs.

◆ Symbol

string QuantConnect.Commands.AddSecurityCommand.Symbol
getset

The security's ticker symbol

Definition at line 34 of file AddSecurityCommand.cs.

◆ Resolution

Resolution QuantConnect.Commands.AddSecurityCommand.Resolution
getset

The requested resolution, defaults to Resolution.Minute

Definition at line 39 of file AddSecurityCommand.cs.

◆ Market

string QuantConnect.Commands.AddSecurityCommand.Market
getset

The security's market, defaults to QuantConnect.Market.USA except for Forex, defaults to QuantConnect.Market.FXCM

Definition at line 44 of file AddSecurityCommand.cs.

◆ FillDataForward

bool QuantConnect.Commands.AddSecurityCommand.FillDataForward
getset

The fill forward behavior, true to fill forward, false otherwise - defaults to true

Definition at line 49 of file AddSecurityCommand.cs.

◆ Leverage

decimal QuantConnect.Commands.AddSecurityCommand.Leverage
getset

The leverage for the security, defaults to 2 for equity, 50 for forex, and 1 for everything else

Definition at line 54 of file AddSecurityCommand.cs.

◆ ExtendedMarketHours

bool QuantConnect.Commands.AddSecurityCommand.ExtendedMarketHours
getset

The extended market hours flag, true to allow pre/post market data, false for only in market data

Definition at line 59 of file AddSecurityCommand.cs.


The documentation for this class was generated from the following file: