Skip to main content

set_keys

Set API keys in bundle.

Source Code: [link]

openbb.keys.set_keys(keys_dict: Dict[str, Dict[str, Union[str, bool]]], persist: bool = False, show_output: bool = False)

Parameters

NameTypeDescriptionDefaultOptional
keys_dictDict[str, Dict[str, Union[str, bool]]]More info on the required inputs for each API can be found on keys.get_keys_info()NoneFalse
persistboolIf False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False.
FalseTrue
show_outputboolDisplay status string or not. By default, False.FalseTrue

Returns

TypeDescription
DictStatus of each key set.

Examples

from openbb_terminal.sdk import openbb
d = {
"fred": {"key": "XXXXX"},
"binance": {"key": "YYYYY", "secret": "ZZZZZ"},
}
openbb.keys.set_keys(keys_dict=d)