Lean  $LEAN_TAG$
QuantConnect Namespace Reference

Classes

class  AlgorithmConfiguration
 This class includes algorithm configuration settings and parameters. This is used to include configuration parameters in the result packet to be used for report generation. More...
 
class  AlgorithmControl
 Wrapper for algorithm status enum to include the charting subscription. More...
 
class  AlgorithmSettings
 This class includes user settings for the algorithm which can be changed in the IAlgorithm.Initialize method More...
 
class  BaseSeries
 Chart Series Object - Series data and properties for a chart: More...
 
class  BinaryComparison
 Enumeration class defining binary comparisons and providing access to expressions and functions capable of evaluating a particular comparison for any type. If a particular type does not implement a binary comparison than an exception will be thrown. More...
 
class  BinaryComparisonExtensions
 Provides convenience extension methods for applying a BinaryComparison to collections. More...
 
class  Candlestick
 Single candlestick for a candlestick chart More...
 
class  CandlestickSeries
 Candlestick Chart Series Object - Series data and properties for a candlestick chart More...
 
class  CapacityEstimate
 Estimates dollar volume capacity of algorithm (in account currency) using all Symbols in the portfolio. More...
 
class  ChannelStatus
 Defines the different channel status values More...
 
class  Chart
 Single Parent Chart Object for Custom Charting More...
 
class  ChartPoint
 Single Chart Point Value Type for QCAlgorithm.Plot(); More...
 
class  ChartSeriesJsonConverter
 Convert a Chart Series to and from JSON More...
 
class  Compression
 Compression class manages the opening and extraction of compressed files (zip, tar, tar.gz). More...
 
class  Country
 The Country class contains all countries normalized for your convenience. It maps the country name to its ISO 3166-1 alpha-3 code, see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3 More...
 
class  Currencies
 Provides commonly used currency pairs and symbols More...
 
class  DataDownloaderGetParameters
 Model class for passing in parameters for historical data More...
 
class  DataMonitorReport
 Report generated by the IDataMonitor class that contains information about data requests More...
 
class  DataProviderEventArgs
 Defines a base class for IDataProviderEvents More...
 
class  DateFormat
 Shortcut date format strings More...
 
class  DefaultConverter
 Helper json converter to use the default json converter, breaking inheritance json converter More...
 
class  DocumentationAttribute
 Custom attribute used for documentation More...
 
class  DownloadFailedEventArgs
 Event arguments for the IDataProviderEvents.DownloadFailed event More...
 
class  Exchange
 Lean exchange definition More...
 
class  Exchanges
 Defines Lean exchanges codes and names More...
 
class  Expiry
 Provides static functions that can be used to compute a future DateTime (expiry) given a DateTime. More...
 
class  ExtendedDictionary
 Provides a base class for types holding instances keyed by Symbol More...
 
class  Extensions
 Extensions function collections - group all static extensions functions here. More...
 
class  Field
 Provides static properties to be used as selectors with the indicator system More...
 
class  FileExtension
 Helper methods for file management More...
 
class  Globals
 Provides application level constant values More...
 
class  Holding
 Singular holding of assets from backend live nodes: More...
 
interface  IDataDownloader
 Data Downloader Interface for pulling data from a remote source. More...
 
interface  IIsolatorLimitResultProvider
 Provides an abstraction for managing isolator limit results. This is originally intended to be used by the training feature to permit a single algorithm time loop to extend past the default of ten minutes More...
 
class  InvalidConfigurationDetectedEventArgs
 Event arguments for the IDataProviderEvents.InvalidConfigurationDetected event More...
 
interface  ISeriesPoint
 Single chart series point/bar data. More...
 
class  Isolator
 Isolator class - create a new instance of the algorithm and ensure it doesn't exceed memory or time execution limits. More...
 
class  IsolatorLimitResult
 Represents the result of the Isolator limiter callback More...
 
class  IsolatorLimitResultProvider
 Provides access to the NullIsolatorLimitResultProvider and extension methods supporting ScheduledEvent More...
 
interface  ITimeProvider
 Provides access to the current time in UTC. This doesn't necessarily need to be wall-clock time, but rather the current time in some system More...
 
class  LocalTimeKeeper
 Represents the current local time. This object is created via the TimeKeeper to manage conversions to local time. More...
 
class  Market
 Markets Collection: Soon to be expanded to a collection of items specifying the market hour, timezones and country codes. More...
 
class  Messages
 Provides user-facing message construction methods and static messages for the Algorithm.Framework.Alphas.Analysis namespace More...
 
class  NewTradableDateEventArgs
 Event arguments for the NewTradableDate event More...
 
class  NumericalPrecisionLimitedEventArgs
 Event arguments for the IDataProviderEvents.NumericalPrecisionLimited event More...
 
class  OS
 Operating systems class for managing anything that is operation system specific. More...
 
class  Parse
 Provides methods for parsing strings using CultureInfo.InvariantCulture More...
 
class  ReaderErrorDetectedEventArgs
 Event arguments for the IDataProviderEvents.ReaderErrorDetected event More...
 
class  RealTimeProvider
 Provides an implementation of ITimeProvider that uses DateTime.UtcNow to provide the current time More...
 
class  RealTimeSynchronizedTimer
 Real time timer class for precise callbacks on a millisecond resolution in a self managed thread. More...
 
class  RegressionTestException
 Custom exception class for regression tests More...
 
class  Result
 Base class for backtesting and live results that packages result data. LiveResult BacktestResult More...
 
class  ScatterChartPoint
 A chart point for a scatter series plot More...
 
class  ScatterChartPointJsonConverter
 ScatterChartPoint json converter More...
 
class  SecurityIdentifier
 Defines a unique identifier for securities More...
 
class  Series
 Chart Series Object - Series data and properties for a chart: More...
 
class  SeriesSampler
 A type capable of taking a chart and resampling using a linear interpolation strategy More...
 
class  StartDateLimitedEventArgs
 Event arguments for the IDataProviderEvents.StartDateLimited event More...
 
class  StringExtensions
 Provides extension methods for properly parsing and serializing values while properly using an IFormatProvider/CultureInfo when applicable More...
 
class  StubsIgnoreAttribute
 P Custom attribute used for marking classes, methods, properties, etc. that should be ignored by the stubs generator More...
 
class  Symbol
 Represents a unique security identifier. This is made of two components, the unique SID and the Value. The value is the current ticker symbol while the SID is constant over the life of a security More...
 
class  SymbolCache
 Provides a string->Symbol mapping to allow for user defined strings to be lifted into a Symbol This is mainly used via the Symbol implicit operator, but also functions that create securities should also call Set to add new mappings More...
 
class  SymbolCapacity
 Per-symbol capacity estimations, tightly coupled with the CapacityEstimate class.
 
class  SymbolJsonConverter
 Defines a JsonConverter to be used when deserializing to the Symbol class. More...
 
class  SymbolRepresentation
 Public static helper class that does parsing/generation of symbol representations (options, futures) More...
 
class  SymbolValueJsonConverter
 Defines a JsonConverter to be used when you only want to serialize the Symbol.Value property instead of the full Symbol instance More...
 
class  Time
 Time helper class collection for working with trading dates More...
 
class  TimeKeeper
 Provides a means of centralizing time for various time zones. More...
 
class  TimeUpdatedEventArgs
 Event arguments class for the LocalTimeKeeper.TimeUpdated event More...
 
class  TimeZoneOffsetProvider
 Represents the discontinuties in a single time zone and provides offsets to UTC. This type assumes that times will be asked in a forward marching manner. This type is not thread safe. More...
 
class  TimeZones
 Provides access to common time zones More...
 
class  TradingCalendar
 Class represents trading calendar, populated with variety of events relevant to currently trading instruments More...
 
class  TradingDay
 Class contains trading events associated with particular day in TradingCalendar More...
 
class  ZipStreamWriter
 Provides an implementation of TextWriter to write to a zip file More...
 

Enumerations

enum  SeriesType {
  SeriesType.Line, SeriesType.Scatter, SeriesType.Candle, SeriesType.Bar,
  SeriesType.Flag, SeriesType.StackedArea, SeriesType.Pie, SeriesType.Treemap,
  SeriesType.Heatmap = 9, SeriesType.Scatter3d
}
 Available types of chart series More...
 
enum  ChartType { ChartType.Overlay, ChartType.Stacked }
 Type of chart - should we draw the series as overlayed or stacked More...
 
enum  BrokerageEnvironment { BrokerageEnvironment.Live, BrokerageEnvironment.Paper }
 Represents the types of environments supported by brokerages for trading More...
 
enum  Language {
  Language.CSharp, Language.FSharp, Language.VisualBasic, Language.Java,
  Language.Python
}
 Multilanguage support enum: which language is this project for the interop bridge converter. More...
 
enum  ServerType { ServerType.Server512, ServerType.Server1024, ServerType.Server2048 }
 Live server types available through the web IDE. / QC deployment. More...
 
enum  SecurityType {
  SecurityType.Base, SecurityType.Equity, SecurityType.Option, SecurityType.Commodity,
  SecurityType.Forex, SecurityType.Future, SecurityType.Cfd, SecurityType.Crypto,
  SecurityType.FutureOption, SecurityType.Index, SecurityType.IndexOption, SecurityType.CryptoFuture
}
 Type of tradable security / underlying asset More...
 
enum  AccountType { AccountType.Margin, AccountType.Cash }
 Account type: margin or cash More...
 
enum  MarketDataType {
  MarketDataType.Base, MarketDataType.TradeBar, MarketDataType.Tick, MarketDataType.Auxiliary,
  MarketDataType.QuoteBar, MarketDataType.OptionChain, MarketDataType.FuturesChain
}
 Market data style: is the market data a summary (OHLC style) bar, or is it a time-price value. More...
 
enum  DataFeedEndpoint { DataFeedEndpoint.Backtesting, DataFeedEndpoint.FileSystem, DataFeedEndpoint.LiveTrading, DataFeedEndpoint.Database }
 Datafeed enum options for selecting the source of the datafeed. More...
 
enum  StoragePermissions { StoragePermissions.Public, StoragePermissions.Authenticated }
 Cloud storage permission options. More...
 
enum  TickType { TickType.Trade, TickType.Quote, TickType.OpenInterest }
 Types of tick data More...
 
enum  DelistingType { DelistingType.Warning = 0, DelistingType.Delisted = 1 }
 Specifies the type of QuantConnect.Data.Market.Delisting data More...
 
enum  SplitType { SplitType.Warning = 0, SplitType.SplitOccurred = 1 }
 Specifies the type of QuantConnect.Data.Market.Split data More...
 
enum  Resolution {
  Resolution.Tick, Resolution.Second, Resolution.Minute, Resolution.Hour,
  Resolution.Daily
}
 Resolution of data requested. More...
 
enum  PositionSide { PositionSide.Short = -1, PositionSide.None = 0, PositionSide.Long = 1 }
 Specifies what side a position is on, long/short More...
 
enum  OptionRight { OptionRight.Call, OptionRight.Put }
 Specifies the different types of options More...
 
enum  OptionStyle { OptionStyle.American, OptionStyle.European }
 Specifies the style of an option More...
 
enum  SettlementType { SettlementType.PhysicalDelivery, SettlementType.Cash }
 Specifies the type of settlement in derivative deals More...
 
enum  AlgorithmStatus {
  AlgorithmStatus.DeployError, AlgorithmStatus.InQueue, AlgorithmStatus.Running, AlgorithmStatus.Stopped,
  AlgorithmStatus.Liquidated, AlgorithmStatus.Deleted, AlgorithmStatus.Completed, AlgorithmStatus.RuntimeError,
  AlgorithmStatus.Invalid, AlgorithmStatus.LoggingIn, AlgorithmStatus.Initializing, AlgorithmStatus.History
}
 States of a live deployment. More...
 
enum  SubscriptionTransportMedium {
  SubscriptionTransportMedium.LocalFile, SubscriptionTransportMedium.RemoteFile, SubscriptionTransportMedium.Rest, SubscriptionTransportMedium.Streaming,
  SubscriptionTransportMedium.ObjectStore
}
 Specifies where a subscription's data comes from More...
 
enum  WritePolicy { WritePolicy.Overwrite = 0, WritePolicy.Merge, WritePolicy.Append }
 Used by the Data.LeanDataWriter to determine which merge write policy should be applied More...
 
enum  Period {
  Period.TenSeconds = 10, Period.ThirtySeconds = 30, Period.OneMinute = 60, Period.TwoMinutes = 120,
  Period.ThreeMinutes = 180, Period.FiveMinutes = 300, Period.TenMinutes = 600, Period.FifteenMinutes = 900,
  Period.TwentyMinutes = 1200, Period.ThirtyMinutes = 1800, Period.OneHour = 3600, Period.TwoHours = 7200,
  Period.FourHours = 14400, Period.SixHours = 21600
}
 enum Period - Enum of all the analysis periods, AS integers. Reference "Period" Array to access the values More...
 
enum  DataNormalizationMode {
  DataNormalizationMode.Raw, DataNormalizationMode.Adjusted, DataNormalizationMode.SplitAdjusted, DataNormalizationMode.TotalReturn,
  DataNormalizationMode.ForwardPanamaCanal, DataNormalizationMode.BackwardsPanamaCanal, DataNormalizationMode.BackwardsRatio, DataNormalizationMode.ScaledRaw
}
 Specifies how data is normalized before being sent into an algorithm More...
 
enum  DataMappingMode { DataMappingMode.LastTradingDay, DataMappingMode.FirstDayMonth, DataMappingMode.OpenInterest, DataMappingMode.OpenInterestAnnual }
 Continuous contracts mapping modes More...
 
enum  CashBookUpdateType { CashBookUpdateType.Added, CashBookUpdateType.Removed, CashBookUpdateType.Updated }
 The different types of CashBook.Updated events More...
 
enum  DeploymentTarget { DeploymentTarget.CloudPlatform, DeploymentTarget.LocalPlatform, DeploymentTarget.PrivateCloudPlatform }
 Represents the types deployment targets for algorithms More...
 
enum  AlgorithmMode { AlgorithmMode.Live, AlgorithmMode.Optimization, AlgorithmMode.Backtesting, AlgorithmMode.Research }
 Represents the deployment modes of an algorithm More...
 
enum  ScatterMarkerSymbol {
  ScatterMarkerSymbol.None, ScatterMarkerSymbol.Circle, ScatterMarkerSymbol.Square, ScatterMarkerSymbol.Diamond,
  ScatterMarkerSymbol.Triangle, ScatterMarkerSymbol.TriangleDown
}
 Shape or symbol for the marker in a scatter plot More...
 
enum  TradingDayType {
  TradingDayType.BusinessDay, TradingDayType.PublicHoliday, TradingDayType.Weekend, TradingDayType.OptionExpiration,
  TradingDayType.FutureExpiration, TradingDayType.FutureRoll, TradingDayType.SymbolDelisting, TradingDayType.EquityDividends,
  TradingDayType.EconomicEvent
}
 Enum lists available trading events More...
 

Enumeration Type Documentation

◆ SeriesType

Available types of chart series

Enumerator
Line 

Line Plot for Value Types (0)

Scatter 

Scatter Plot for Chart Distinct Types (1)

Candle 

Charts (2)

Bar 

Bar chart (3)

Flag 

Flag indicators (4)

StackedArea 

100% area chart showing relative proportions of series values at each time index (5)

Pie 

Pie chart (6)

Treemap 

Treemap Plot (7)

Heatmap 

Heatmap Plot (9) – NOTE: 8 is reserved.

Scatter3d 

Scatter 3D Plot (10)

Definition at line 259 of file BaseSeries.cs.

◆ ChartType

Type of chart - should we draw the series as overlayed or stacked

Enumerator
Overlay 

Overlayed stacked (0)

Stacked 

Stacked series on top of each other. (1)

Definition at line 205 of file Chart.cs.

◆ BrokerageEnvironment

Represents the types of environments supported by brokerages for trading

Enumerator
Live 

Live trading (0)

Paper 

Paper trading (1)

Definition at line 168 of file Global.cs.

◆ Language

enum QuantConnect.Language
strong

Multilanguage support enum: which language is this project for the interop bridge converter.

Enumerator
CSharp 

C# Language Project (0)

FSharp 

FSharp Project (1)

VisualBasic 

Visual Basic Project (2)

Java 

Java Language Project (3)

Python 

Python Language Project (4)

Definition at line 187 of file Global.cs.

◆ ServerType

Live server types available through the web IDE. / QC deployment.

Enumerator
Server512 

Additional server (0)

Server1024 

Upgraded server (1)

Server2048 

Server with 2048 MB Ram (2)

Definition at line 223 of file Global.cs.

◆ SecurityType

Type of tradable security / underlying asset

Enumerator
Base 

Base class for all security types (0)

Equity 

US Equity Security (1)

Option 

Option Security Type (2)

Commodity 

Commodity Security Type (3)

Forex 

FOREX Security (4)

Future 

Future Security Type (5)

Cfd 

Contract For a Difference Security Type (6)

Crypto 

Cryptocurrency Security Type (7)

FutureOption 

Futures Options Security Type (8)

Futures options function similar to equity options, but with a few key differences. Firstly, the contract unit of trade is 1x, rather than 100x. This means that each option represents the right to buy or sell 1 future contract at expiry/exercise. The contract multiplier for Futures Options plays a big part in determining the premium of the option, which can also differ from the underlying future's multiplier.

Index 

Index Security Type (9)

IndexOption 

Index Option Security Type (10)

For index options traded on American markets, they tend to be European-style options and are Cash-settled.

CryptoFuture 

Crypto Future Type (11)

Definition at line 244 of file Global.cs.

◆ AccountType

Account type: margin or cash

Enumerator
Margin 

Margin account type (0)

Cash 

Cash account type (1)

Definition at line 320 of file Global.cs.

◆ MarketDataType

Market data style: is the market data a summary (OHLC style) bar, or is it a time-price value.

Enumerator
Base 

Base market data type (0)

TradeBar 

TradeBar market data type (OHLC summary bar) (1)

Tick 

Tick market data type (price-time pair) (2)

Auxiliary 

Data associated with an instrument (3)

QuoteBar 

QuoteBar market data type (4) [Bid(OHLC), Ask(OHLC) and Mid(OHLC) summary bar].

OptionChain 

Option chain data (5)

FuturesChain 

Futures chain data (6)

Definition at line 336 of file Global.cs.

◆ DataFeedEndpoint

Datafeed enum options for selecting the source of the datafeed.

Enumerator
Backtesting 

Backtesting Datafeed Endpoint (0)

FileSystem 

Loading files off the local system (1)

LiveTrading 

Getting datafeed from a QC-Live-Cloud (2)

Database 

Database (3)

Definition at line 357 of file Global.cs.

◆ StoragePermissions

Cloud storage permission options.

Enumerator
Public 

Public Storage Permissions (0)

Authenticated 

Authenticated Read Storage Permissions (1)

Definition at line 372 of file Global.cs.

◆ TickType

enum QuantConnect.TickType
strong

Types of tick data

QuantConnect currently only has trade, quote, open interest tick data.

Enumerator
Trade 

Trade type tick object (0)

Quote 

Quote type tick object (1)

OpenInterest 

Open Interest type tick object (for options, futures) (2)

Definition at line 385 of file Global.cs.

◆ DelistingType

Specifies the type of QuantConnect.Data.Market.Delisting data

Enumerator
Warning 

Specifies a warning of an imminent delisting (0)

Delisted 

Specifies the symbol has been delisted (1)

Definition at line 398 of file Global.cs.

◆ SplitType

Specifies the type of QuantConnect.Data.Market.Split data

Enumerator
Warning 

Specifies a warning of an imminent split event (0)

SplitOccurred 

Specifies the symbol has been split (1)

Definition at line 414 of file Global.cs.

◆ Resolution

Resolution of data requested.

Always sort the enum from the smallest to largest resolution

Enumerator
Tick 

Tick Resolution (0)

Second 

Second Resolution (1)

Minute 

Minute Resolution (2)

Hour 

Hour Resolution (3)

Daily 

Daily Resolution (4)

Definition at line 431 of file Global.cs.

◆ PositionSide

Specifies what side a position is on, long/short

Enumerator
Short 

A short position, quantity less than zero (-1)

None 

No position, quantity equals zero (0)

Long 

A long position, quantity greater than zero (1)

Definition at line 448 of file Global.cs.

◆ OptionRight

Specifies the different types of options

Enumerator
Call 

A call option, the right to buy at the strike price (0)

Put 

A put option, the right to sell at the strike price (1)

Definition at line 469 of file Global.cs.

◆ OptionStyle

Specifies the style of an option

Enumerator
American 

American style options are able to be exercised at any time on or before the expiration date (0)

European 

European style options are able to be exercised on the expiration date only (1)

Definition at line 485 of file Global.cs.

◆ SettlementType

Specifies the type of settlement in derivative deals

Enumerator
PhysicalDelivery 

Physical delivery of the underlying security (0)

Cash 

Cash is paid/received on settlement (1)

Definition at line 501 of file Global.cs.

◆ AlgorithmStatus

States of a live deployment.

Enumerator
DeployError 

Error compiling algorithm at start (0)

InQueue 

Waiting for a server (1)

Running 

Running algorithm (2)

Stopped 

Stopped algorithm or exited with runtime errors (3)

Liquidated 

Liquidated algorithm (4)

Deleted 

Algorithm has been deleted (5)

Completed 

Algorithm completed running (6)

RuntimeError 

Runtime Error Stoped Algorithm (7)

Invalid 

Error in the algorithm id (not used) (8)

LoggingIn 

The algorithm is logging into the brokerage (9)

Initializing 

The algorithm is initializing (10)

History 

History status update (11)

Definition at line 555 of file Global.cs.

◆ SubscriptionTransportMedium

Specifies where a subscription's data comes from

Enumerator
LocalFile 

The subscription's data comes from disk (0)

RemoteFile 

The subscription's data is downloaded from a remote source (1)

Rest 

The subscription's data comes from a rest call that is polled and returns a single line/data point of information (2)

Streaming 

The subscription's data is streamed (3)

ObjectStore 

The subscription's data comes from the object store (4)

Definition at line 586 of file Global.cs.

◆ WritePolicy

Used by the Data.LeanDataWriter to determine which merge write policy should be applied

Enumerator
Overwrite 

Will overwrite any existing file or zip entry with the new content (0)

Merge 

Will inject and merge new content with the existings file content (1)

Append 

Will append new data to the end of the file or zip entry (2)

Definition at line 617 of file Global.cs.

◆ Period

enum QuantConnect.Period
strong

enum Period - Enum of all the analysis periods, AS integers. Reference "Period" Array to access the values

Enumerator
TenSeconds 

Period Short Codes - 10.

ThirtySeconds 

Period Short Codes - 30 Second.

OneMinute 

Period Short Codes - 60 Second.

TwoMinutes 

Period Short Codes - 120 Second.

ThreeMinutes 

Period Short Codes - 180 Second.

FiveMinutes 

Period Short Codes - 300 Second.

TenMinutes 

Period Short Codes - 600 Second.

FifteenMinutes 

Period Short Codes - 900 Second.

TwentyMinutes 

Period Short Codes - 1200 Second.

ThirtyMinutes 

Period Short Codes - 1800 Second.

OneHour 

Period Short Codes - 3600 Second.

TwoHours 

Period Short Codes - 7200 Second.

FourHours 

Period Short Codes - 14400 Second.

SixHours 

Period Short Codes - 21600 Second.

Definition at line 638 of file Global.cs.

◆ DataNormalizationMode

Specifies how data is normalized before being sent into an algorithm

Enumerator
Raw 

No modifications to the asset price at all. For Equities, dividends are paid in cash and splits are applied directly to your portfolio quantity. (0)

Adjusted 

Splits and dividends are backward-adjusted into the price of the asset. The price today is identical to the current market price. (1)

SplitAdjusted 

Equity splits are applied to the price adjustment but dividends are paid in cash to your portfolio. This normalization mode allows you to manage dividend payments (e.g. reinvestment) while still giving a smooth time series of prices for indicators. (2)

TotalReturn 

Equity splits are applied to the price adjustment and the value of all future dividend payments is added to the initial asset price. (3)

ForwardPanamaCanal 

Eliminates price jumps between two consecutive contracts, adding a factor based on the difference of their prices. The first contract has the true price. Factor 0. (4)

First contract is the true one, factor 0

BackwardsPanamaCanal 

Eliminates price jumps between two consecutive contracts, adding a factor based on the difference of their prices. The last contract has the true price. Factor 0. (5)

Last contract is the true one, factor 0

BackwardsRatio 

Eliminates price jumps between two consecutive contracts, multiplying the prices by their ratio. The last contract has the true price. Factor 1. (6)

Last contract is the true one, factor 1

ScaledRaw 

Splits and dividends are adjusted into the prices in a given date. Only for history requests. (7)

Definition at line 673 of file Global.cs.

◆ DataMappingMode

Continuous contracts mapping modes

Enumerator
LastTradingDay 

The contract maps on the previous day of expiration of the front month (0)

FirstDayMonth 

The contract maps on the first date of the delivery month of the front month. If the contract expires prior to this date, then it rolls on the contract's last trading date instead (1)

For example, the Crude Oil WTI (CL) 'DEC 2021 CLZ1' contract expires on November, 19 2021, so the mapping date will be its expiration date.

Another example is the Corn 'DEC 2021 ZCZ1' contract, which expires on December, 14 2021, so the mapping date will be December 1, 2021.

OpenInterest 

The contract maps when the following back month contract has a higher open interest that the current front month (2)

OpenInterestAnnual 

The contract maps when any of the back month contracts of the next year have a higher volume that the current front month (3)

Definition at line 715 of file Global.cs.

◆ CashBookUpdateType

The different types of CashBook.Updated events

Enumerator
Added 

A new Cash.Symbol was added (0)

Removed 

One or more Cash instances were removed (1)

Updated 

An existing Cash.Symbol was updated (2)

Definition at line 741 of file Global.cs.

◆ DeploymentTarget

Represents the types deployment targets for algorithms

Enumerator
CloudPlatform 

Cloud Platform (0)

LocalPlatform 

Local Platform (1)

PrivateCloudPlatform 

Private Cloud Platform (2)

Definition at line 983 of file Global.cs.

◆ AlgorithmMode

Represents the deployment modes of an algorithm

Enumerator
Live 

Live (0)

Optimization 

Optimization (1)

Backtesting 

Backtesting (2)

Research 

Research (3)

Definition at line 1005 of file Global.cs.

◆ ScatterMarkerSymbol

Shape or symbol for the marker in a scatter plot

Enumerator
None 

Circle symbol (0)

Circle 

Circle symbol (1)

Square 

Square symbol (2)

Diamond 

Diamond symbol (3)

Triangle 

Triangle symbol (4)

TriangleDown 

Triangle-down symbol (5)

Definition at line 217 of file Series.cs.

◆ TradingDayType

Enum lists available trading events

Enumerator
BusinessDay 

Business day (0)

PublicHoliday 

Public Holiday (1)

Weekend 

Weekend (2)

OptionExpiration 

Option Expiration Date (3)

FutureExpiration 

Futures Expiration Date (4)

FutureRoll 

Futures Roll Date (5)

Not used yet. For future use.

SymbolDelisting 

Symbol Delisting Date (6)

Not used yet. For future use.

EquityDividends 

Equity Ex-dividend Date (7)

Not used yet. For future use.

EconomicEvent 

FX Economic Event (8)

FX Economic Event e.g. from DailyFx (DailyFx.cs). Not used yet. For future use.

Definition at line 24 of file TradingDay.cs.