AlphaResultPacket

QuantConnect.Packets.AlphaResultPacket

AlphaResultPacket()

AlphaResultPacket(
    algorithm_id: str,
    user_id: int,
    insights: List[Insight] = None,
    order_events: List[OrderEvent] = None,
    orders: List[Order] = None,
)

Bases: Packet

Provides a packet type for transmitting alpha insights data

Initializes a new instance of the AlphaResultPacket class

Parameters:

Name	Type	Description	Default
algorithm_id	Optional[str]	The algorithm's unique identifier	None
user_id	Optional[int]	The user's id	None
insights	Optional[List[Insight]]	Alphas generated by the algorithm	None
order_events	Optional[List[OrderEvent]]	OrderEvents generated by the algorithm	None
orders	Optional[List[Order]]	Orders generated or updated by the algorithm	None

user_id

user_id: int

The user's id that deployed the alpha stream

alpha_id

alpha_id: str

The deployed alpha id. This is the id generated upon submssion to the alpha marketplace. If this is a user backtest or live algo then this will not be specified

algorithm_id

algorithm_id: str

The algorithm's unique identifier

insights

insights: List[Insight]

The generated insights

order_events

order_events: List[OrderEvent]

The generated OrderEvents

orders

orders: List[Order]

The new or updated Orders

type

type: PacketType

Packet type defined by a string enum

channel

channel: str

User unique specific channel endpoint to send the packets