Create API Cheat Sheet

[jaredbroad]

Desired Behavior

• Summarize the top 30 points of the API / group by subject
• Write into a document with the text of each.
• Create a design to display them nicely.

Example below.

Checklist

• [x] I have completely filled out this template
• [x] I have confirmed that this issue exists on the current master branch
• [x] I have confirmed that this is not a duplicate issue by searching issues

[DerekMelchin]

Authentication lean login - Log in with a QuantConnect account. lean init - Create an organization workspace. lean whoami - Display who is logged in. lean logout - Log out and remove stored credentials.

Configuration lean config list - List the configurable options and their current values. lean config get - Get the current value of a configurable option. lean config set - Set a configurable option. lean config unset - Unset a configurable option.

Projects lean project-create - Create a new project containing starter code. lean project-delete - Delete a project on your local machine and in the cloud. lean cloud pull - Pull projects from QuantConnect to your local drive. lean cloud push - Push local projects to QuantConnect. lean library add - Add a custom library to a project. lean library remove - Remove a custom library from a project.

Data lean data download - Purchase and download data from the Dataset Market. lean data generate - Generate realistic market data.

Research Lean research - Run a local Jupyter Lab environment using Docker.

Backtests lean backtest - Backtest a project locally using Docker. lean cloud backtest - Backtest a project in the cloud. lean optimize - Optimize a project locally using Docker. lean cloud optimize - Optimize a project in the cloud.

Live Trading lean live - Start live trading a project locally using Docker. lean live liquidate - Liquidate a specific symbol from the latest local deployment of a project. lean live stop - Stop a local live trading algorithm. lean cloud live - Start live trading for a project in the cloud. lean cloud live liquidate - Stop live trading and liquidate existing positions for a certain project. lean cloud live stop - Stop live trading a certain project without liquidating existing positions. lean cloud status - Show the live trading status of a project in the cloud.

Algorithm Results lean logs - Display the most recent backtest/live/optimization logs. lean report - Generate a report of a backtest or live trading algorithm.