jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 15:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
faa1e896fa66eda12edea8cd4e9df75ebbffd937
OpenBB/website/content/sdk/reference/keys/set_keys.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

1.7 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
set_keys Guide on how to set API keys in bundle with OpenBB finance terminal, including parameters, return values and examples. Contains source code link
OpenBB terminal
API keys
Set keys
Python code
Source code
Jupyter notebook
Finance
Environment variables
Programming guide

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

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)