Skip to main content

ultima

Set Ultima Insights key

Source Code: [link]

openbb.keys.ultima(key: str, persist: bool = False, show_output: bool = False)

Parameters

NameTypeDescriptionDefaultOptional
keystrAPI keyNoneFalse
persistboolIf 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.
FalseTrue
show_outputboolDisplay status string or not. By default, False.FalseTrue

Returns

TypeDescription
strStatus of key set

Examples

from openbb_terminal.sdk import openbb
openbb.keys.ultima(key="example_key")