Files
OpenBB/website/content/sdk/reference/forex/load.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.3 KiB
Vendored

title, description
title description
load OpenBB SDK Function

load

Load forex for two given symbols.

Source Code: [link]

openbb.forex.load(to_symbol: str, from_symbol: str, resolution: str = "d", interval: str = "1day", start_date: str = None, source: str = "YahooFinance", verbose: bool = False)

Parameters

Name Type Description Default Optional
to_symbol str The from currency symbol. Ex: USD, EUR, GBP, YEN None False
from_symbol str The from currency symbol. Ex: USD, EUR, GBP, YEN None False
resolution str The resolution for the data, by default "d" d True
interval str What interval to get data for, by default "1day" 1day True
start_date str When to begin loading in data, by default last_year.strftime("%Y-%m-%d") None True
source str Where to get data from, by default "YahooFinance" YahooFinance True
verbose bool Display verbose information on what was the pair that was loaded, by default True False True

Returns

Type Description
pd.DataFrame The loaded data