QuantConnect.Packets
Classes
| Class | Description |
|---|---|
| AlgorithmNameUpdatePacket | Packet to communicate updates to the algorithm's name |
| AlgorithmNodePacket | Algorithm Node Packet is a work task for the Lean Engine |
| AlgorithmStatusPacket | Algorithm status update information packet |
| AlgorithmTagsUpdatePacket | Packet to communicate updates to the algorithm tags |
| AlphaNodePacket | Alpha job packet |
| AlphaResultPacket | Provides a packet type for transmitting alpha insights data |
| BacktestNodePacket | Algorithm backtest task information packet. |
| BacktestResult | Backtest results object class - result specific items from the packet. |
| BacktestResultPacket | Backtest result packet: send backtest information to GUI for user consumption. |
| BacktestResultParameters | Defines the parameters for BacktestResult |
| BaseResultParameters | Base parameters used by LiveResultParameters and BacktestResultParameters |
| CompletedHistoryResult | Specifies the completed message from a history result |
| Controls | Specifies values used to control algorithm limits |
| DebugPacket | Send a simple debug message from the users algorithm to the console. |
| ErrorHistoryResult | Specfies an error message in a history result |
| FileHistoryResult | Defines requested file data for a history request |
| HandledErrorPacket | Algorithm runtime error packet from the lean engine.... |
| HistoryPacket | Packet for history jobs |
| HistoryRequest | Specifies request parameters for a single historical request.... |
| HistoryResult | Provides a container for results from history requests. This contains... |
| LeakyBucketControlParameters | Provides parameters that control the behavior of a leaky bucket rate limiting algorithm. The... |
| LiveNodePacket | Live job task packet: container for any live specific job variables |
| LiveResult | Live results object class for packaging live result data. |
| LiveResultPacket | Live result packet from a lean engine algorithm. |
| LiveResultParameters | Defines the parameters for LiveResult |
| LogPacket | Simple log message instruction from the lean engine. |
| MarketHours | Market open hours model for pre, normal and post market hour definitions. |
| MarketToday | Market today information class |
| OrderEventPacket | Order event packet for passing updates on the state of an order to the portfolio. |
| Packet | Base class for packet messaging system |
| PythonEnvironmentPacket | Python Environment Packet is an abstract packet that contains a PythonVirtualEnvironment... |
| ResearchNodePacket | Represents a research node packet |
| RuntimeErrorPacket | Algorithm runtime error packet from the lean engine.... |
| SecurityTypesPacket | Security types packet contains information on the markets the user data has requested. |
| StatusHistoryResult | Specifies the progress of a request |
| StoragePermissions | Holds the permissions for the object store |
| SystemDebugPacket | Debug packets generated by Lean |
Enumerations
Bases: IntEnum
Specifies various types of history results
FILE = 0
The requested file data
STATUS = 1
The request's status
COMPLETED = 2
The request is completed
ERROR = 3
The request had an error
Bases: IntEnum
Classifications of internal packet system
NONE = 0
Default, unset:
ALGORITHM_NODE = 1
Base type for backtest and live work
AUTOCOMPLETE_WORK = 2
Autocomplete Work Packet
AUTOCOMPLETE_RESULT = 3
Result of the Autocomplete Job:
BACKTEST_NODE = 4
Controller->Backtest Node Packet:
BACKTEST_RESULT = 5
Packet out of backtest node:
BACKTEST_WORK = 6
API-> Controller Work Packet:
LIVE_NODE = 7
Controller -> Live Node Packet:
LIVE_RESULT = 8
Live Node -> User Packet:
LIVE_WORK = 9
API -> Controller Packet:
SECURITY_TYPES = 10
Node -> User Algo Security Types
BACKTEST_ERROR = 11
Controller -> User Error in Backtest Settings:
ALGORITHM_STATUS = 12
Nodes -> User Algorithm Status Packet:
BUILD_WORK = 13
API -> Compiler Work Packet:
BUILD_SUCCESS = 14
Compiler -> User Build Success
BUILD_ERROR = 15
Compiler -> User, Compile Error
RUNTIME_ERROR = 16
Node -> User Algorithm Runtime Error
HANDLED_ERROR = 17
Error is an internal handled error packet inside users algorithm
LOG = 18
Nodes -> User Log Message
DEBUG = 19
Nodes -> User Debug Message
ORDER_EVENT = 20
Nodes -> User, Order Update Event
SUCCESS = 21
Boolean true/false success
HISTORY = 22
History live job packets
COMMAND_RESULT = 23
Result from a command
GIT_HUB_HOOK = 24
Hook from git hub
DOCUMENTATION_RESULT = 25
Documentation result from docs server
DOCUMENTATION = 26
Documentation request to the docs server
SYSTEM_DEBUG = 27
Debug packet generated by Lean
ALPHA_RESULT = 28
Packet containing insights generated by the algorithm
ALPHA_WORK = 29
Alpha API -> Controller packet
ALPHA_NODE = 30
Alpha Controller -> Alpha Node packet
REGRESSION_ALGORITHM = 31
Packet containing list of algorithms to run as a regression test
ALPHA_HEARTBEAT = 32
Packet containing a heartbeat
DEBUGGING_STATUS = 33
Used when debugging to send status updates
OPTIMIZATION_NODE = 34
Optimization Node Packet:
OPTIMIZATION_ESTIMATE = 35
Optimization Estimate Packet:
OPTIMIZATION_STATUS = 36
Optimization work status update
OPTIMIZATION_RESULT = 37
Optimization work result
AGGREGATED = 38
Aggregated packets
LANGUAGE_MODEL_QUERY = 39
Query the language model
LANGUAGE_MODEL_FEEDBACK = 40
Send feedback to a language model response
LANGUAGE_MODEL_RESPONSE = 41
The language models response
LANGUAGE_MODEL_CODE_ANALYSIS = 42
Language model code analysis
LANGUAGE_MODEL_CHAT_WORK = 43
Language model chat work
LANGUAGE_MODEL_CHAT_RESPONSE = 44
Language model chat response
ALGORITHM_NAME_UPDATE = 45
Algorithm name update
ALGORITHM_TAGS_UPDATE = 46
Algorithm tags update
RESEARCH_NODE = 47
Research job packet
ORGANIZATION_UPDATE = 48
Organization update
BUILD_WARNING = 49
Compiler -> User Build Warnings
LANGUAGE_MODEL_FUNCTION_CALL = 50
Language model function call related packet
LANGUAGE_MODEL_AGENT_MESSAGE = 51
Language model agent message