Lean  $LEAN_TAG$
QuantConnect.Api Namespace Reference

Classes

class  Account
 Account information for an organization More...
 
class  Api
 QuantConnect.com Interaction Via API. More...
 
class  ApiConnection
 API Connection and Hash Manager More...
 
class  Authentication
 Helper methods for api authentication and interaction More...
 
class  AuthenticationResponse
 Verify if the credentials are OK. More...
 
class  Backtest
 Results object class. Results are exhaust from backtest or live algorithms running in LEAN More...
 
class  BacktestList
 Collection container for a list of backtests for a project More...
 
class  BacktestReport
 Backtest Report Response wrapper More...
 
class  BacktestResponseWrapper
 Wrapper class for Backtest/* endpoints JSON response Currently used by Backtest/Read and Backtest/Create More...
 
class  BacktestSummary
 Result object class for the List Backtest response from the API More...
 
class  BacktestSummaryList
 Collection container for a list of backtest summaries for a project More...
 
class  BacktestTags
 Collection container for a list of backtest tags More...
 
class  BaseLiveAlgorithm
 Class representing the REST response from QC API when creating or reading a live algorithm More...
 
class  BaseOptimization
 BaseOptimization item from the QuantConnect.com API. More...
 
class  BasicBacktest
 Base class for backtest result object response More...
 
class  BasicObjectStore
 Class contining basic store properties present in the REST response from QC API More...
 
class  Card
 Credit card More...
 
class  Collaborator
 Collaborator responses More...
 
class  Compile
 Response from the compiler on a build event More...
 
class  CreatedNode
 Rest api response wrapper for node/create, reads in the nodes information into a node object More...
 
class  CreateLiveAlgorithmResponse
 Class representing the REST response from QC API when creating a live algorithm More...
 
class  Credit
 Organization Credit Object More...
 
class  DataAgreement
 Organization Data Agreement More...
 
class  DataLink
 Data/Read response wrapper, contains link to requested data More...
 
class  DataList
 Data/List response wrapper for available data More...
 
class  DataPricesList
 Data/Prices response wrapper for prices by vendor More...
 
class  EncryptionKey
 Encryption key details More...
 
class  Estimate
 Estimate response packet from the QuantConnect.com API. More...
 
class  EstimateResponseWrapper
 Wrapper class for Optimizations/* endpoints JSON response Currently used by Optimizations/Estimate More...
 
class  GetObjectStoreResponse
 Response received when fetching Object Store More...
 
class  Grid
 The grid arrangement of charts More...
 
class  GridChart
 The chart display properties More...
 
class  InsightResponse
 Class containing insights and the number of insights of the live algorithm in the request criteria More...
 
class  Library
 Library response More...
 
class  ListObjectStoreResponse
 Response received containing a list of stored objects metadata, as well as the total size of all of them. More...
 
class  LiveAlgorithmApiSettingsWrapper
 Helper class to put BaseLiveAlgorithmSettings in proper format. More...
 
class  LiveAlgorithmResults
 Details a live algorithm from the "live/read" Api endpoint More...
 
class  LiveAlgorithmResultsJsonConverter
 Custom JsonConverter for LiveResults data for live algorithms More...
 
class  LiveAlgorithmSummary
 Response from List Live Algorithms request to QuantConnect Rest API. More...
 
class  LiveList
 List of the live algorithms running which match the requested status More...
 
class  LiveLog
 Logs from a live algorithm More...
 
class  LiveResultsData
 Holds information about the state and operation of the live running algorithm More...
 
class  Node
 Node class built for API endpoints nodes/read and nodes/create. Converts JSON properties from API response into data members for the class. Contains all relevant information on a Node to interact through API endpoints. More...
 
class  NodeList
 Collection of Node objects for each target environment. More...
 
class  NodePrices
 Class for deserializing node prices from node object More...
 
class  Optimization
 Optimization response packet from the QuantConnect.com API. More...
 
class  OptimizationBacktest
 OptimizationBacktest object from the QuantConnect.com API. More...
 
class  OptimizationBacktestJsonConverter
 Json converter for OptimizationBacktest which creates a light weight easy to consume serialized version More...
 
class  OptimizationList
 Collection container for a list of summarized optimizations for a project More...
 
class  OptimizationNodes
 Supported optimization nodes More...
 
class  OptimizationResponseWrapper
 Wrapper class for Optimizations/Read endpoint JSON response More...
 
class  OptimizationSummary
 Optimization summary response for creating an optimization More...
 
class  Organization
 Object representation of Organization from QuantConnect Api More...
 
class  OrganizationResponse
 Response wrapper for Organizations/Read More...
 
class  Parameter
 Parameter set More...
 
class  ParameterSetJsonConverter
 Json converter for ParameterSet which creates a light weight easy to consume serialized version More...
 
class  Portfolio
 Class containing the basic portfolio information of a live algorithm More...
 
class  PortfolioResponse
 Response class for reading the portfolio of a live algorithm More...
 
class  PriceEntry
 Prices entry for Data/Prices response More...
 
class  Product
 QuantConnect Products More...
 
class  ProductItem
 QuantConnect ProductItem More...
 
class  Project
 Response from reading a project by id. More...
 
class  ProjectFile
 File for a project More...
 
class  ProjectFilesResponse
 Response received when creating a file or reading one file or more in a project More...
 
class  ProjectNodesResponse
 Response received when reading or updating some nodes of a project More...
 
class  ProjectResponse
 Project list response More...
 
class  PropertiesObjectStore
 Object Store file properties More...
 
class  PropertiesObjectStoreResponse
 Response received containing the properties of the requested Object Store More...
 
class  ReadChartResponse
 Class for wrapping Read Chart response More...
 
class  ResearchGuide
 A power gauge for backtests, time and parameters to estimate the overfitting risk More...
 
class  RestResponse
 Base API response class for the QuantConnect API. More...
 
class  SKU
 Class for generating a SKU for a node with a given configuration Every SKU is made up of 3 variables: More...
 
class  StringRepresentation
 Class to return the string representation of an API response class More...
 
class  SummaryObjectStore
 Summary information of the Object Store More...
 
class  Version
 API response for version More...
 
class  VersionsResponse
 Read versions response More...
 

Enumerations

enum  CompileState { CompileState.InQueue, CompileState.BuildSuccess, CompileState.BuildError }
 State of the compilation request More...
 
enum  NodeType { NodeType.Backtest, NodeType.Research, NodeType.Live }
 NodeTypes enum for all possible options of target environments Used in conjuction with SKU class as a NodeType is a required parameter for SKU More...
 
enum  ProductType {
  ProductType.ProfessionalSeats, ProductType.BacktestNode, ProductType.ResearchNode, ProductType.LiveNode,
  ProductType.Support, ProductType.Data, ProductType.Modules
}
 Product types offered by QuantConnect Used by Product class More...
 

Enumeration Type Documentation

◆ CompileState

State of the compilation request

Enumerator
InQueue 

Compile waiting in the queue to be processed.

BuildSuccess 

Compile was built successfully

BuildError 

Build error, check logs for more information

Definition at line 20 of file CompileState.cs.

◆ NodeType

NodeTypes enum for all possible options of target environments Used in conjuction with SKU class as a NodeType is a required parameter for SKU

Enumerator
Backtest 

A node for running backtests.

Research 

A node for running research.

Live 

A node for live trading.

Definition at line 244 of file Nodes.cs.

◆ ProductType

Product types offered by QuantConnect Used by Product class

Enumerator
ProfessionalSeats 

Professional Seats Subscriptions

BacktestNode 

Backtest Nodes Subscriptions

ResearchNode 

Research Nodes Subscriptions

LiveNode 

Live Trading Nodes Subscriptions

Support 

Support Subscriptions

Data 

Data Subscriptions

Modules 

Modules Subscriptions

Definition at line 131 of file Organization.cs.