API Reference

lean login

Introduction

Log in with a QuantConnect account.

$ lean login [options]

Description

Lets you log in with your QuantConnect API credentials and stores the given values in the credentials file in your global configuration directory.

If --user-id or --api-token is not provided an interactive prompt is shown and the missing values are read from stdin.

You can request your user id and API token by clicking on the "Request Email With Token and Your User-Id for API Requests" link on your QuantConnect Account page. After clicking on this link your user id and API token are automatically sent to your email address.

Options

The lean login command supports the following options:

OptionDescription
-u, --user-id <value>The QuantConnect user id to log in with.
-t, --api-token <value>The QuantConnect API token to log in with.
--verboseEnable debug logging.
--helpDisplay the help text of the lean login command and exit.

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

Did you find this page helpful?

Contribute to the documentation: