Files
OpenBB/website/content/sdk/reference/keys/reddit.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.4 KiB
Vendored

title, description
title description
reddit OpenBB SDK Function

reddit

Set Reddit key

Source Code: [link]

openbb.keys.reddit(client_id: str, client_secret: str, password: str, username: str, useragent: str, persist: bool = False, show_output: bool = False)

Parameters

Name Type Description Default Optional
client_id str Client ID None False
client_secret str Client secret None False
password str User password None False
username str User username None False
useragent str User useragent 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
str Status of key set

Examples

    client_id="example_id",
    client_secret="example_secret",
    password="example_password",
    username="example_username",
    useragent="example_useragent"
)
from openbb_terminal.sdk import openbb
openbb.keys.reddit(