QuantConnect.Api
Classes
| Class | Description |
|---|---|
| Account | Account information for an organization |
| Api | QuantConnect.com Interaction Via API. |
| ApiConnection | API Connection and Hash Manager |
| Authentication | Helper methods for api authentication and interaction |
| AuthenticationResponse | Verify if the credentials are OK. |
| Backtest | Results object class. Results are exhaust from backtest or live algorithms running in LEAN |
| BacktestList | Collection container for a list of backtests for a project |
| BacktestReport | Backtest Report Response wrapper |
| BacktestResponseWrapper | Wrapper class for Backtest/* endpoints JSON response... |
| BacktestSummary | Result object class for the List Backtest response from the API |
| BacktestSummaryList | Collection container for a list of backtest summaries for a project |
| BacktestTags | Collection container for a list of backtest tags |
| BaseLiveAlgorithm | Class representing the REST response from QC API when creating or reading a live algorithm |
| BaseOptimization | BaseOptimization item from the QuantConnect.com API. |
| BasicBacktest | Base class for backtest result object response |
| BasicObjectStore | Class contining basic store properties present in the REST response from QC API |
| Card | Credit card |
| Collaborator | Collaborator responses |
| Compile | Response from the compiler on a build event |
| CreatedNode | Rest api response wrapper for node/create, reads in the nodes information into a... |
| CreateLiveAlgorithmResponse | Class representing the REST response from QC API when creating a live algorithm |
| Credit | Organization Credit Object |
| DataAgreement | Organization Data Agreement |
| DataLink | Data/Read response wrapper, contains link to requested data |
| DataList | Data/List response wrapper for available data |
| DataPricesList | Data/Prices response wrapper for prices by vendor |
| EncryptionKey | Encryption key details |
| Estimate | Estimate response packet from the QuantConnect.com API. |
| EstimateResponseWrapper | Wrapper class for Optimizations/* endpoints JSON response... |
| GetObjectStoreResponse | Response received when fetching Object Store |
| Grid | The grid arrangement of charts |
| GridChart | The chart display properties |
| InsightResponse | Class containing insights and the number of insights of the live algorithm in the request criteria |
| Library | Library response |
| ListObjectStoreResponse | Response received containing a list of stored objects metadata, as well as the total size of all of them. |
| LiveAlgorithmApiSettingsWrapper | Helper class to put BaseLiveAlgorithmSettings in proper format. |
| LiveAlgorithmResults | Details a live algorithm from the "live/read" Api endpoint |
| LiveAlgorithmResultsJsonConverter | Custom JsonConverter for LiveResults data for live algorithms |
| LiveAlgorithmSummary | Response from List Live Algorithms request to QuantConnect Rest API. |
| LiveList | List of the live algorithms running which match the requested status |
| LiveLog | Logs from a live algorithm |
| LiveResultsData | Holds information about the state and operation of the live running algorithm |
| Node | Node class built for API endpoints nodes/read and nodes/create.... |
| NodeList | Collection of Node objects for each target environment. |
| NodePrices | Class for deserializing node prices from node object |
| Optimization | Optimization response packet from the QuantConnect.com API. |
| OptimizationBacktest | OptimizationBacktest object from the QuantConnect.com API. |
| OptimizationBacktestJsonConverter | Json converter for OptimizationBacktest which creates a light weight easy to consume serialized version |
| OptimizationList | Collection container for a list of summarized optimizations for a project |
| OptimizationNodes | Supported optimization nodes |
| OptimizationResponseWrapper | Wrapper class for Optimizations/Read endpoint JSON response |
| OptimizationSummary | Optimization summary response for creating an optimization |
| Organization | Object representation of Organization from QuantConnect Api |
| OrganizationResponse | Response wrapper for Organizations/Read |
| Parameter | Parameter set |
| ParameterSetJsonConverter | Json converter for ParameterSet which creates a light weight easy to consume serialized version |
| Portfolio | Class containing the basic portfolio information of a live algorithm |
| PortfolioResponse | Response class for reading the portfolio of a live algorithm |
| PriceEntry | Prices entry for Data/Prices response |
| Product | QuantConnect Products |
| ProductItem | QuantConnect ProductItem |
| Project | Response from reading a project by id. |
| ProjectFile | File for a project |
| ProjectFilesResponse | Response received when creating a file or reading one file or more in a project |
| ProjectNodesResponse | Response received when reading or updating some nodes of a project |
| ProjectResponse | Project list response |
| PropertiesObjectStore | Object Store file properties |
| PropertiesObjectStoreResponse | Response received containing the properties of the requested Object Store |
| ReadChartResponse | Class for wrapping Read Chart response |
| ResearchGuide | A power gauge for backtests, time and parameters to estimate the overfitting risk |
| RestResponse | Base API response class for the QuantConnect API. |
| SKU | Class for generating a SKU for a node with a given configuration... |
| StringRepresentation | Class to return the string representation of an API response class |
| SummaryObjectStore | Summary information of the Object Store |
| Version | API response for version |
| VersionsResponse | Read versions response |
Enumerations
Bases: IntEnum
State of the compilation request
IN_QUEUE = 0
Compile waiting in the queue to be processed.
BUILD_SUCCESS = 1
Compile was built successfully
BUILD_ERROR = 2
Build error, check logs for more information
Bases: IntEnum
NodeTypes enum for all possible options of target environments Used in conjuction with SKU class as a NodeType is a required parameter for SKU
BACKTEST = 0
A node for running backtests (0)
RESEARCH = 1
A node for running research (1)
LIVE = 2
A node for live trading (2)
Bases: IntEnum
Product types offered by QuantConnect Used by Product class
PROFESSIONAL_SEATS = 0
Professional Seats Subscriptions
BACKTEST_NODE = 1
Backtest Nodes Subscriptions
RESEARCH_NODE = 2
Research Nodes Subscriptions
LIVE_NODE = 3
Live Trading Nodes Subscriptions
SUPPORT = 4
Support Subscriptions
DATA = 5
Data Subscriptions
MODULES = 6
Modules Subscriptions