jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 23:12:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
948d2ef29900c48ec26616eb48ba952aaaadd883
OpenBB/website/content/sdk/reference/forex/oanda/orderbook.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
2023-10-30 21:01:29 +00:00

2.2 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
orderbook This documentation page hosts information on 'Orderbook' operations in forex trading using the 'Oanda' platform, powered by 'OpenBB'. It includes Python source code, various parameters, and return types. Also addressed is plotting an 'Orderbook' chart with 'matplotlib'.
orderbook
oanda
forex
currency pair
accountID
orderbook chart
matplotlib
pandas DataFrame

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

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

Request order book data for plotting.

Source Code: [link]

openbb.forex.oanda.orderbook(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] Order book data or False

Plot the orderbook for the instrument if Oanda provides one.

Source Code: [link]

openbb.forex.oanda.orderbook_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