jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-30 22:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
7c57fb71c5bc1032dfd4ef4f3edfc74afa8c0a2e
OpenBB/website/content/sdk/reference/keys/set_keys.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.2 KiB
Vendored
Raw Blame History

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

    "fred": {"key": "XXXXX"},
    "binance": {"key": "YYYYY", "secret": "ZZZZZ"},
}

from openbb_terminal.sdk import openbb
d = {