Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/keys/set_keys.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470)
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.3 KiB
Vendored

title, description
title description
set_keys OpenBB SDK Function

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

Name Type Description Default Optional
keys_dict Dict[str, Dict[str, Union[str, bool]]] More info on the required inputs for each API can be found on keys.get_keys_info() None False
persist bool If 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.
False True
show_output bool Display status string or not. By default, False. False True

Returns

Type Description
Dict Status 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)