mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
Add in Forex Menu guide and apply redirect to a terminal page that shouldn't exist (#2011)
* Add redirect * Add in Forex guide * Update _index.md * Remove images Co-authored-by: DidierRLopes <dro.lopes@campus.fct.unl.pt>
This commit is contained in:
Jeroen Bouma
BIN
images/installation/api_keys_part_1.png
vendored
BIN
images/installation/api_keys_part_1.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 153 KiB |
BIN
images/installation/api_keys_part_2.png
vendored
BIN
images/installation/api_keys_part_2.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 35 KiB |
BIN
images/installation/macos/mac_os_installation.png
vendored
BIN
images/installation/macos/mac_os_installation.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 3.1 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 261 KiB |
BIN
images/installation/macos/option_one_warning_fix.png
vendored
BIN
images/installation/macos/option_one_warning_fix.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 604 KiB |
BIN
images/installation/macos/option_two_warning_fix.png
vendored
BIN
images/installation/macos/option_two_warning_fix.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 293 KiB |
BIN
images/installation/windows/run_anyway.png
vendored
BIN
images/installation/windows/run_anyway.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 145 KiB |
BIN
images/installation/windows/run_the_terminal.png
vendored
BIN
images/installation/windows/run_the_terminal.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 117 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 119 KiB |
82
website/content/terminal/_index.md
vendored
82
website/content/terminal/_index.md
vendored
@@ -1,81 +1,5 @@
|
||||
---
|
||||
title: OpenBB Terminal
|
||||
---
|
||||
OpenBB is a leading open source investment analysis company. We represent millions of investors who want to leverage
|
||||
state-of-the-art data science and machine learning technologies to make sense of raw unrefined data. Our mission
|
||||
is to make investment research effective, powerful and accessible to everyone.
|
||||
|
||||
**All our products are Free and Open-Source (FOSS).**
|
||||
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable MD033 -->
|
||||
|
||||
[![Stargazers][stars-shield]][stars-url]
|
||||
[![Forks][forks-shield]][forks-url]
|
||||
[![Contributors][contributors-shield]][contributors-url]
|
||||
[![MIT License][license-shield]][license-url]
|
||||
[![Twitter][twitter-shield]][twitter-url]
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
|
||||
{{< columns >}}
|
||||
|
||||
### Why Python?
|
||||
|
||||
Python is one of the most used programming languages due to its simplified syntax and shallow learning curve.
|
||||
On top of this, it is highly used in data science and academia world (particularly on finance, economics
|
||||
or business related degrees). This is very important, as it is the first time in history that users - regardless
|
||||
of their background - can so easily add features to an investment research platform.
|
||||
|
||||
<--->
|
||||
|
||||
### Why Open Source?
|
||||
|
||||
An open source product allows for higher quality, greater reproducibility, lower costs, more transparency,
|
||||
and faster go-to-market due to the strong community created. In addition, users can adapt the platform to their
|
||||
needs or even build proprietary features on top of our infrastructure - which ultimately can result in a marketplace.
|
||||
|
||||
<--->
|
||||
|
||||
### Importing and Exporting data
|
||||
|
||||
The terminal allows for users to import their own proprietary datasets to use on our econometrics menu. In addition, users are allowed to export any type of data to any type of format whether that is raw data in Excel or an image in PNG. This is also ideal for finance content creation.
|
||||
|
||||
{{< /columns >}}
|
||||
|
||||
{{< columns >}}
|
||||
|
||||
### Automatic notebook reports
|
||||
|
||||
Create notebook templates (through papermill) which can be run on different tickers. This level of automation allows speeding up the development of your investment thesis and reduce human error.
|
||||
|
||||
<--->
|
||||
|
||||
### OpenBB API and Customizable notebook reports
|
||||
|
||||
Use our OpenBB Terminal environment to access raw data through a Jupyter Notebook and play with it accordingly. Or just create customizable notebook reports for your colleagues and friends doing research on a particular asset or a macroeconomic event impact on said asset. The possibilities are endless.
|
||||
|
||||
<--->
|
||||
|
||||
### Advanced user and routines
|
||||
|
||||
Navigate through 750+ terminal features using fast shortcuts and leverage auto-complete functionality. Jump from looking into your portfolio to comparing the financials of those companies in a few seconds. Leverage our routines implementation to run analysis while you drink your coffee or tea.
|
||||
|
||||
{{< /columns >}}
|
||||
|
||||
[contributors-shield]: https://img.shields.io/github/contributors/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
||||
[contributors-url]: https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors
|
||||
[forks-shield]: https://img.shields.io/github/forks/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
||||
[forks-url]: https://github.com/OpenBB-finance/OpenBBTerminal/network/members
|
||||
[stars-shield]: https://img.shields.io/github/stars/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
||||
[stars-url]: https://github.com/OpenBB-finance/OpenBBTerminal/stargazers
|
||||
[issues-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge&color=blue
|
||||
[issues-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues
|
||||
[bugs-open-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=yellow
|
||||
[bugs-open-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aopen
|
||||
[bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success
|
||||
[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed
|
||||
[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
|
||||
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE
|
||||
[twitter-shield]: https://img.shields.io/twitter/follow/openbb_finance?style=for-the-badge&color=blue
|
||||
[twitter-url]: https://twitter.com/openbb_finance
|
||||
<head>
|
||||
<meta http-equiv="Refresh" content="0; URL=https://openbb-finance.github.io/OpenBBTerminal/">
|
||||
</head>
|
||||
142
website/content/terminal/forex/_index.md
vendored
142
website/content/terminal/forex/_index.md
vendored
@@ -1,12 +1,144 @@
|
||||
---
|
||||
title: Introduction to Forex
|
||||
keywords: "forex, currency, money, hedge, dollar, euro"
|
||||
excerpt: "The Introduction to Forex explains how to use the
|
||||
menu and provides a brief description of its sub-menus"
|
||||
geekdocCollapseSection: true
|
||||
---
|
||||
The Forex menu enables you to <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/load/" target="_blank">load</a> any combination of currencies (e.g. USDEUR or JPYGBP), show current <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/quote/" target="_blank">quote</a> and historical data (<a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/candle/" target="_blank">candle</a>) as well as
|
||||
forward rates (<a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/fwd/" target="_blank">fwd</a>). Furthermore, the menu has the ability to also apply
|
||||
<a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/common/technical_analysis/" target="_blank">Technical Analysis</a> and <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/common/prediction_techniques/" target="_blank">Prediction Techniques</a> while also having an integration with <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/oanda/" target="_blank">Oanda</a>.
|
||||
|
||||
Forex trading takes place in the foreign exchange market. Currency is significant because it allows us to buy goods and services both locally and internationally. To undertake international trade and business, international currencies must be exchanged.
|
||||
## How to use
|
||||
|
||||
If you live in the United States and wish to purchase goods from Europe, you or the firm from which you purchase the goods must pay in euros (EUR). This means that the importer in the United States would have to convert the same amount of dollars (USD) into euros.
|
||||
The Forex menu is called upon by typing `forex` which opens the following menu:
|
||||
|
||||
The same is true when it comes to traveling. Because euros are not accepted in China, visitors must exchange euros for the local currency.
|
||||
|
||||
|
||||
**Available commands**
|
||||
{{< toc-tree >}}
|
||||
You have the ability to load any currency pair with <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/load/" target="_blank">load</a> as follows:
|
||||
|
||||
|
||||
|
||||
When you do so, a lot of commands turn <span style="color:#00AAFF">Blue</span>. These can now be used to analyse the selected currency pair.
|
||||
|
||||
|
||||
|
||||
For example, you are able to show the quote of the currency pair by using the <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/quote/" target="_blank">quote</a> command:
|
||||
|
||||
```
|
||||
2022 Jun 29, 07:04 (🦋) /forex/ $ quote
|
||||
|
||||
USD/EUR Quote
|
||||
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
|
||||
┃ ┃ Realtime Currency Exchange Rate ┃
|
||||
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
|
||||
│ From_Currency Code │ USD │
|
||||
├────────────────────┼─────────────────────────────────┤
|
||||
│ To_Currency Code │ EUR │
|
||||
├────────────────────┼─────────────────────────────────┤
|
||||
│ Last Refreshed │ 2022-06-29 11:08:00 │
|
||||
├────────────────────┼─────────────────────────────────┤
|
||||
│ Exchange Rate │ 0.94960000 │
|
||||
├────────────────────┼─────────────────────────────────┤
|
||||
│ Bid Price │ 0.94960000 │
|
||||
├────────────────────┼─────────────────────────────────┤
|
||||
│ Ask Price │ 0.94960000 │
|
||||
└────────────────────┴─────────────────────────────────┘
|
||||
```
|
||||
|
||||
Or show the historical data on the currency pair with <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/candle/" target="_blank">candle</a> as follows:
|
||||
```
|
||||
2022 Jun 29, 07:09 (🦋) /forex/ $ candle
|
||||
```
|
||||
|
||||
Which returns the following:
|
||||
|
||||
|
||||
|
||||
Lastly, insights in the forward valuations can also be given with <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/forex/fwd/" target="_blank">fwd</a>.
|
||||
|
||||
```
|
||||
2022 Jun 29, 07:19 (🦋) /forex/ $ fwd
|
||||
|
||||
Forward rates for USD/EUR
|
||||
┏━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┓
|
||||
┃ Expirations ┃ Ask ┃ Bid ┃ Mid ┃ Points ┃
|
||||
┡━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━┩
|
||||
│ Overnight │ 0.9499 │ 0.9498 │ 0.9499 │ -0.5750 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Tomorrow Next │ 0.9499 │ 0.9498 │ 0.9498 │ -0.7250 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Spot Next │ 0.9497 │ 0.9496 │ 0.9497 │ -2.3450 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ One Week │ 0.9495 │ 0.9495 │ 0.9495 │ -4.1550 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Two Weeks │ 0.9491 │ 0.9491 │ 0.9491 │ -8.2600 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Three Weeks │ 0.9487 │ 0.9486 │ 0.9487 │ -12.4150 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ One Month │ 0.9481 │ 0.9480 │ 0.9480 │ -18.8850 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Two Months │ 0.9459 │ 0.9458 │ 0.9458 │ -40.8200 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Three Months │ 0.9436 │ 0.9435 │ 0.9436 │ -63.4650 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Four Months │ 0.9415 │ 0.9414 │ 0.9415 │ -84.5500 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Five Months │ 0.9394 │ 0.9392 │ 0.9393 │ -106.2650 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Six Months │ 0.9361 │ 0.9360 │ 0.9360 │ -138.8800 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Seven Months │ 0.9342 │ 0.9340 │ 0.9341 │ -158.3750 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Eight Months │ 0.9323 │ 0.9322 │ 0.9322 │ -176.9850 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Nine Months │ 0.9302 │ 0.9300 │ 0.9301 │ -198.1200 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Ten Months │ 0.9284 │ 0.9283 │ 0.9284 │ -215.5000 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Eleven Months │ 0.9268 │ 0.9267 │ 0.9268 │ -231.6250 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ One Year │ 0.9252 │ 0.9250 │ 0.9251 │ -248.6650 │
|
||||
├───────────────┼────────┼────────┼────────┼───────────┤
|
||||
│ Two Years │ 0.9111 │ 0.9106 │ 0.9109 │ -390.6350 │
|
||||
└───────────────┴────────┴────────┴────────┴───────────┘
|
||||
```
|
||||
|
||||
Furthermore, the ability exists to take the currency pair to the <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/common/technical_analysis/" target="_blank">Technical Analysis</a> menu by typing `ta`:
|
||||
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
First, let's start with looking at the currency pair USD and GBP. These are the U.S. Dollars and the Pound sterling.
|
||||
This is done by using the `load` command as follows with the addition that the `-s` command is used to change the start date:
|
||||
|
||||
```
|
||||
2022 Jun 29, 07:16 (🦋) /forex/ $ load USDGBP -s 2015-01-01
|
||||
USD-GBP loaded.
|
||||
```
|
||||
|
||||
Then, let's see how this currency pair has changed over the last years with `candle` also adding in the `--ma 60,120` argument:
|
||||
|
||||
|
||||
|
||||
Now it's time to take this to the <a href="https://openbb-finance.github.io/OpenBBTerminal/terminal/common/quantitative_analysis/" target="_blank">Quantitative Analysis</a> menu by typing `qa`. This returns the following:
|
||||
|
||||
|
||||
|
||||
Within this menu we can show some rolling statistics, for example show the rolling values for the mean and standard deviation
|
||||
of the currency pair:
|
||||
|
||||
|
||||
|
||||
Lastly, more advanced techniques can also be applied regarding seasonality with `decompose`:
|
||||
|
||||
```
|
||||
2022 Jun 29, 07:26 (🦋) /forex/qa/ $ decompose
|
||||
|
||||
Time-Series Level is 0.75
|
||||
Strength of Trend: 421.7107
|
||||
Strength of Seasonality: 0.0031
|
||||
```
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user