Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/keys/rh.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.1 KiB
Vendored

title, description
title description
rh OpenBB SDK Function

rh

Set Robinhood key

Source Code: [link]

openbb.keys.rh(username: str, password: str, persist: bool = False, show_output: bool = False)

Parameters

Name Type Description Default Optional
username str User username None False
password str User password 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

from openbb_terminal.sdk import openbb
openbb.keys.rh(
username="example_username",
        password="example_password"
    )