Skip to content

AlgorithmStatusCommand

QuantConnect.Commands.AlgorithmStatusCommand

AlgorithmStatusCommand()
AlgorithmStatusCommand(status: AlgorithmStatus)

Bases: BaseCommand

Represents a command that will change the algorithm's status

Signature descriptions:

  • Initializes a new instance of the AlgorithmStatusCommand

  • Initializes a new instance of the AlgorithmStatusCommand with the specified status

status

Gets or sets the algorithm status

id

id: str

Unique command id

run

run(algorithm: IAlgorithm) -> CommandResultPacket

Sets the algorithm's status to status

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