API Reference
lean live update-order
Introduction
Represents a command to update a specific order by id.
$ lean live update-order [OPTIONS] PROJECT
Description
Sends a command to a running local live trading algorithm to update an existing order.
The --order-id option is required and must match the ID of the order you want to update.
You can update the quantity, limit price, stop price, and tag of the order.
Provide only the fields you want to change; omitted fields remain unchanged.
The algorithm must already be running via lean live deploy before you use this command.
Options
The lean live update-order command supports the following options:
| Option | Description |
|---|---|
--order-id <integer> | [required] |
--quantity <float> | The number of units to be updated (directional) |
--limit-price <float> | The limit price of the order to be updated |
--stop-price <float> | The stop price of the order to be updated |
--tag <string> | The tag to be attached to the order |
--lean-config <file> | The Lean configuration file that should be used (defaults to the nearest lean.json) |
--verbose | Enable debug logging |
--help | Display the help text of the lean live update-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:
