API Reference

lean live cancel-order

Introduction

Represents a command to cancel a specific order by id.

$ lean live cancel-order [OPTIONS] PROJECT

To use the CLI, you must be a member in an organization on a paid tier.

Description

Sends a command to a running local live trading algorithm to cancel a specific open order. The --order-id option is required and must match the ID of the order you want to cancel.

The algorithm must already be running via lean live deploy before you use this command.

Arguments

The lean live cancel-order command expects the following arguments:

ArgumentDescription
<project>The path to the project directory or algorithm file that contains the order you want to cancel.

Options

The lean live cancel-order command supports the following options:

OptionDescription
--order-id <integer>[required]
--lean-config <file>The Lean configuration file that should be used (defaults to the nearest lean.json)
--verboseEnable debug logging
--helpDisplay the help text of the lean live cancel-order command and exit

You can also see our Videos. You can also get in touch with us via Discord.

Did you find this page helpful?

Contribute to the documentation: