BrokerageMessageEvent

QuantConnect.Brokerages.BrokerageMessageEvent

BrokerageMessageEvent(
    type: BrokerageMessageType, code: int, message: str
)

BrokerageMessageEvent(
    type: BrokerageMessageType, code: str, message: str
)

Bases: Object

Represents a message received from a brokerage

Initializes a new instance of the BrokerageMessageEvent class

Parameters:

Name	Type	Description	Default
type	BrokerageMessageType	The type of brokerage message	required
code	int | str	The brokerage specific code	required
message	str	The message text received from the brokerage	required

type

type: BrokerageMessageType

Gets the type of brokerage message

code

code: str

Gets the brokerage specific code for this message, zero if no code was specified

message

message: str

Gets the message text received from the brokerage

disconnected

disconnected(message: str) -> BrokerageMessageEvent

Creates a new BrokerageMessageEvent to represent a disconnect message

Parameters:

Name	Type	Description	Default
message	str	The message from the brokerage	required

Returns:

Type	Description
BrokerageMessageEvent	A brokerage disconnect message.

reconnected

reconnected(message: str) -> BrokerageMessageEvent

Creates a new BrokerageMessageEvent to represent a reconnect message

Parameters:

Name	Type	Description	Default
message	str	The message from the brokerage	required

Returns:

Type	Description
BrokerageMessageEvent	A brokerage reconnect message.

to_string

to_string() -> str

Returns a string that represents the current object.

Returns:

Type	Description
str	A string that represents the current object.