Files
OpenBB/website/content/api/forex/oanda/summary/_index.md
Colin Delahunty 0b33cb45f8 Adds auto yaml generation (#2587)
* Began working on docs creator

* Added fixes

* More

* More

* Adding autogen_try.py for OpenBB API doc generation

* OpenBB API docs gen try

* Fixed

* Added fixes

* Added fixes

* subs -> sub

* Updated docs

* Updated docs

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
2022-09-23 16:43:34 +01:00

618 B
Vendored

To obtain charts, make sure to add chart=True as the last parameter

Get underlying data

forex.oanda.summary(accountID: str = 'REPLACE_ME') -> Union[pandas.core.frame.DataFrame, bool]

Request Oanda account summary.

Parameters
----------
accountID : str, optional
    Oanda account ID, by default cfg.OANDA_ACCOUNT

Returns
-------
Union[pd.DataFrame, bool]
    Account summary data or False

Getting charts

forex.oanda.summary(accountID: str, chart=True)

Print Oanda account summary.

Parameters
----------
accountID : str
    Oanda user account ID