jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 13:01:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/forex/oanda/positionbook.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.7 KiB
Vendored
Raw Blame History

title, description
title description
positionbook OpenBB SDK Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

positionbook

Request position book data for plotting.

Source Code: [link]

openbb.forex.oanda.positionbook(instrument: Optional[str] = None, accountID: str = "REPLACE_ME")

Parameters

Name Type Description Default Optional
instrument Union[str, None] The loaded currency pair, by default None None True
accountID str Oanda account ID, by default cfg.OANDA_ACCOUNT REPLACE_ME True

Returns

Type Description
Union[pd.DataFrame, bool] Position book data or False

Plot a position book for an instrument if Oanda provides one.

Source Code: [link]

openbb.forex.oanda.positionbook_chart(accountID: str, instrument: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
accountID str Oanda user account ID None False
instrument str The loaded currency pair True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything