OpenBB/website/content/sdk/reference/keys/rh.md

title, description, keywords

title	description	keywords
rh	This page provides detailed information on setting the Robinhood key using the openbb keys function. It includes source code, parameters description, return types, and usage examples. This Python SDK function allows users to handle their Robinhood key in different environments including Jupyter notebook sessions and terminal environment variables.	Robinhood keys username and password API key Jupyter notebook session terminal environment variables

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

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"
    )

---