jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-04 00:12:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/forex/oanda/calendar.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

1.9 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
calendar Provides a comprehensive guide on the Oanda calendar functionality in the OpenBB finance package. Details include how to request data of significant events, parameters for currency pair and days, model and view interfaces, and corresponding source code.
oanda
forex
calendar
events
data
currency pair
advance
model
view
chart
OpenBB-finance

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

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

Request data of significant events calendar.

Source Code: [link]

openbb.forex.oanda.calendar(days: int = 14, instrument: Optional[str] = None)

Parameters

Name Type Description Default Optional
instrument Union[str, None] The loaded currency pair, by default None None True
days int Number of days in advance 14 True

Returns

Type Description
Union[pd.DataFrame, bool] Calendar events data or False

View calendar of significant events.

Source Code: [link]

openbb.forex.oanda.calendar_chart(instrument: str, days: int = 7)

Parameters

Name Type Description Default Optional
instrument str The loaded currency pair None False
days int Number of days in advance 7 True

Returns

This function does not return anything