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

title, description, keywords
title description keywords
load The page provides an explanation of the 'load' feature that is used to load forex data for two given symbols. It includes the source code link and details about the parameters including to_symbol, from_symbol, resolution, interval, start_date, source, and verbose.
forex data
currency symbols
forex parameters
load forex data
forex data source
YahooFinance forex data
data resolution
data interval
verbose data loading

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

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: Optional[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 Optional[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