Skip to main content

login

Login and load user info.

Source Code: [link]

openbb.root.login(email: str = "", password: str = "", token: str = "", keep_session: bool = False, silent: bool = False)

Parameters

NameTypeDescriptionDefaultOptional
emailstrThe email.True
passwordstrThe password.True
tokenstrThe OpenBB Personal Access Token.True
keep_sessionboolKeep the session, i.e., next time the user logs in,
there is no need to enter the email and password or the token.
FalseTrue
silentboolIf True, the console print will be silent.FalseTrue

Returns

This function does not return anything


Examples

from openbb_terminal.sdk import openbb
openbb.login(email="your_email", password="your_password")