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

title, description
title description
oanda OpenBB SDK Function

oanda

Set Oanda key

Source Code: [link]

openbb.keys.oanda(account: str, access_token: str, account_type: str = "", persist: bool = False, show_output: bool = False)

Parameters

Name Type Description Default Optional
account str User account None False
access_token str User token None False
account_type str User account type True
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.oanda(
account="example_account",
        access_token="example_access_token",
        account_type="example_account_type"
    )