mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
66 lines
1.7 KiB
Markdown
Vendored
66 lines
1.7 KiB
Markdown
Vendored
---
|
|
title: set_keys
|
|
description: Guide on how to set API keys in bundle with OpenBB finance terminal,
|
|
including parameters, return values and examples. Contains source code link
|
|
keywords:
|
|
- 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';
|
|
|
|
<HeadTitle title="keys.set_keys - Reference | OpenBB SDK Docs" />
|
|
|
|
Set API keys in bundle.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L116)]
|
|
|
|
```python
|
|
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.<br/>If True, api key change will be global, i.e. it will affect terminal environment variables.<br/>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
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
d = {
|
|
```
|
|
|
|
```
|
|
"fred": {"key": "XXXXX"},
|
|
"binance": {"key": "YYYYY", "secret": "ZZZZZ"},
|
|
}
|
|
```
|
|
```python
|
|
openbb.keys.set_keys(keys_dict=d)
|
|
```
|
|
|
|
---
|