Skip to content

CancelOrderCommand

QuantConnect.Commands.CancelOrderCommand

Bases: BaseCommand

Represents a command to cancel a specific order by id

order_id

order_id: int

Gets or sets the order id to be cancelled

id

id: str

Unique command id

Result

Result(
    command: ICommand, success: bool, quantity_filled: float
)

Bases: CommandResultPacket

Result packet type for the CancelOrderCommand command

Initializes a new instance of the Result class

quantity_filled

quantity_filled: float

Gets or sets the quantity filled on the cancelled order

type

type: PacketType

Packet type defined by a string enum

channel

channel: str

User unique specific channel endpoint to send the packets

command_name

command_name: str

Gets or sets the command that produced this packet

success

success: Optional[bool]

Gets or sets whether or not the

run

run(algorithm: IAlgorithm) -> CommandResultPacket

Runs this command against the specified algorithm instance

Parameters:

Name Type Description Default
algorithm IAlgorithm

The algorithm to run this command against

required

get_symbol

get_symbol(
    ticker: str,
    security_type: SecurityType,
    market: str,
    symbol: Union[Symbol, str, BaseContract] = None,
) -> Symbol

Creats symbol using symbol properties.

This codeEntityType is protected.

Parameters:

Name Type Description Default
ticker str

The string ticker symbol

required
security_type SecurityType

The security type of the ticker. If security_type == Option, then a canonical symbol is created

required
market str

The market the ticker resides in

required
symbol Union[Symbol, str, BaseContract]

The algorithm to run this command against

None