mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
Another batch of markdownlint updates (#901)
* Another batch of markdownlint updates * Update additional markdowns in gamestonk_terminal/
This commit is contained in:
2
.github/workflows/test.yml
vendored
2
.github/workflows/test.yml
vendored
@@ -94,7 +94,7 @@ jobs:
|
|||||||
- name: Lint Code Base
|
- name: Lint Code Base
|
||||||
uses: docker://avtodev/markdown-lint:v1
|
uses: docker://avtodev/markdown-lint:v1
|
||||||
with:
|
with:
|
||||||
args: "./gamestonk_terminal/options/README.md ./*.md ./changelogs/*.md ./gamestonk_terminal/common/**/*.md ./gamestonk_terminal/cryptocurrency/**/*.md"
|
args: "./*.md ./changelogs/*.md ./gamestonk_terminal/**/*.md"
|
||||||
tests-python:
|
tests-python:
|
||||||
name: Vanilla Python Tests - (${{ matrix.python-version }}, ${{ matrix.os }})
|
name: Vanilla Python Tests - (${{ matrix.python-version }}, ${{ matrix.os }})
|
||||||
needs: test
|
needs: test
|
||||||
|
|||||||
3
.markdownlintrc
vendored
3
.markdownlintrc
vendored
@@ -3,7 +3,8 @@
|
|||||||
"MD025": false,
|
"MD025": false,
|
||||||
"MD013": {
|
"MD013": {
|
||||||
"line_length": 120,
|
"line_length": 120,
|
||||||
"tables": false
|
"tables": false,
|
||||||
|
"code_blocks": false
|
||||||
},
|
},
|
||||||
"MD033": false,
|
"MD033": false,
|
||||||
"MD036": false,
|
"MD036": false,
|
||||||
|
|||||||
24
gamestonk_terminal/README.md
vendored
24
gamestonk_terminal/README.md
vendored
@@ -1,6 +1,6 @@
|
|||||||
# Features 📈
|
# Features 📈
|
||||||
|
|
||||||
### Table of contents
|
## Table of contents
|
||||||
|
|
||||||
* [Discover Stocks](#Discover-Stocks-)
|
* [Discover Stocks](#Discover-Stocks-)
|
||||||
* [Behavioural Analysis](#Behavioural-Analysis-)
|
* [Behavioural Analysis](#Behavioural-Analysis-)
|
||||||
@@ -30,11 +30,12 @@
|
|||||||
|
|
||||||
The main menu allows the following commands:
|
The main menu allows the following commands:
|
||||||
|
|
||||||
```
|
```text
|
||||||
usage: load [-t S_TICKER] [-s S_START_DATE] [-i {1,5,15,30,60}] [--source {yf,av,iex}] [-p]
|
usage: load [-t S_TICKER] [-s S_START_DATE] [-i {1,5,15,30,60}] [--source {yf,av,iex}] [-p]
|
||||||
```
|
```
|
||||||
|
|
||||||
* Load stock ticker to perform analysis on. When the data source is 'yf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in <https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html>.
|
* Load stock ticker to perform analysis on. When the data source is 'yf', an Indian ticker can be loaded by using '.NS'
|
||||||
|
at the end, e.g. 'SBIN.NS'. See available market in <https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html>.
|
||||||
* -t : Stock ticker
|
* -t : Stock ticker
|
||||||
* -s : The starting date (format YYYY-MM-DD) of the stock
|
* -s : The starting date (format YYYY-MM-DD) of the stock
|
||||||
* -i : Intraday stock minutes
|
* -i : Intraday stock minutes
|
||||||
@@ -43,29 +44,28 @@ usage: load [-t S_TICKER] [-s S_START_DATE] [-i {1,5,15,30,60}] [--source {yf,av
|
|||||||
|
|
||||||
**Note:** Until a ticker is loaded, the menu will only show *disc* and *sen* menu, as the others require a ticker being provided.
|
**Note:** Until a ticker is loaded, the menu will only show *disc* and *sen* menu, as the others require a ticker being provided.
|
||||||
|
|
||||||
```
|
```text
|
||||||
usage: clear
|
usage: clear
|
||||||
```
|
```
|
||||||
|
|
||||||
* Clear previously loaded stock ticker.
|
* Clear previously loaded stock ticker.
|
||||||
|
|
||||||
```
|
```text
|
||||||
view
|
view
|
||||||
```
|
```
|
||||||
|
|
||||||
* Visualise historical data of a stock.
|
* Visualize historical data of a stock.
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
Line plot color is configurable in config_plot.py
|
Line plot color is configurable in config_plot.py
|
||||||
|
|
||||||
```
|
```text
|
||||||
quote -t S_TICKER
|
quote -t S_TICKER
|
||||||
```
|
```
|
||||||
|
|
||||||
* Show the current price of a stock.
|
* Show the current price of a stock.
|
||||||
|
|
||||||
```
|
```text
|
||||||
candle -s START_DATE
|
candle -s START_DATE
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -73,7 +73,7 @@ candle -s START_DATE
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
```
|
```text
|
||||||
export -f GNUS_data -F csv
|
export -f GNUS_data -F csv
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -413,7 +413,6 @@ Command|Description|Source
|
|||||||
`gl_bonds` | Global bonds overview | <https://www.wsj.com/market-data>
|
`gl_bonds` | Global bonds overview | <https://www.wsj.com/market-data>
|
||||||
`currencies` | Global currencies overview | <https://www.wsj.com/market-data>
|
`currencies` | Global currencies overview | <https://www.wsj.com/market-data>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Options [»](options/README.md)
|
## Options [»](options/README.md)
|
||||||
@@ -527,8 +526,8 @@ Command|Website
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Government [»](government/README.md)
|
## Government [»](government/README.md)
|
||||||
|
|
||||||
Command|Website
|
Command|Website
|
||||||
----|----
|
----|----
|
||||||
`last_congress` | last congress trading
|
`last_congress` | last congress trading
|
||||||
@@ -555,6 +554,7 @@ with ticker provided |
|
|||||||
|
|
||||||
|
|
||||||
## ETF [»](etf/README.md)
|
## ETF [»](etf/README.md)
|
||||||
|
|
||||||
command|description
|
command|description
|
||||||
---|----
|
---|----
|
||||||
`web`|open webbroswer to stockanalysis.com
|
`web`|open webbroswer to stockanalysis.com
|
||||||
|
|||||||
65
gamestonk_terminal/economy/README.md
vendored
65
gamestonk_terminal/economy/README.md
vendored
@@ -3,11 +3,11 @@
|
|||||||
This menu aims to assess economy data, and the usage of the following commands along with an example will be exploited below.
|
This menu aims to assess economy data, and the usage of the following commands along with an example will be exploited below.
|
||||||
|
|
||||||
* [feargreed](#feargreed)
|
* [feargreed](#feargreed)
|
||||||
* CNN Fear Greed Index from https://money.cnn.com/data/fear-and-greed/
|
* CNN Fear Greed Index from <https://money.cnn.com/data/fear-and-greed/>
|
||||||
* [events](#events)
|
* [events](#events)
|
||||||
* economic impact events [Finnhub]
|
* economic impact events [Finnhub]
|
||||||
* [fred](#fred)
|
* [fred](#fred)
|
||||||
* display customized FRED from https://fred.stlouisfed.org
|
* display customized FRED from <https://fred.stlouisfed.org>
|
||||||
* [vixcls](#vixcls)
|
* [vixcls](#vixcls)
|
||||||
* Volatility Index
|
* Volatility Index
|
||||||
* [gdp](#gdp)
|
* [gdp](#gdp)
|
||||||
@@ -32,6 +32,7 @@ This menu aims to assess economy data, and the usage of the following commands a
|
|||||||
* Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)
|
* Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)
|
||||||
|
|
||||||
[WSJ](#wsj)
|
[WSJ](#wsj)
|
||||||
|
|
||||||
* [overview](#overview)
|
* [overview](#overview)
|
||||||
* Get market overview
|
* Get market overview
|
||||||
* [indices](#indices)
|
* [indices](#indices)
|
||||||
@@ -45,26 +46,28 @@ This menu aims to assess economy data, and the usage of the following commands a
|
|||||||
* [currencies](#currencies)
|
* [currencies](#currencies)
|
||||||
* Get global currency overview
|
* Get global currency overview
|
||||||
|
|
||||||
|
|
||||||
## feargreed <a name="feargreed"></a>
|
## feargreed <a name="feargreed"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: feargreed [-i {jbd,mv,pco,mm,sps,spb,shd,index}]
|
usage: feargreed [-i {jbd,mv,pco,mm,sps,spb,shd,index}]
|
||||||
```
|
```
|
||||||
|
|
||||||
Display CNN Fear And Greed Index from https://money.cnn.com/data/fear-and-greed/.
|
Display CNN Fear And Greed Index from <https://money.cnn.com/data/fear-and-greed/>.
|
||||||
* -i : CNN Fear And Greed indicator or index. From Junk Bond Demand, Market Volatility, Put and Call Options, Market Momentum Stock Price, Strength, Stock Price Breadth, Safe Heaven Demand, and Index. Default: None, shows all.
|
|
||||||
|
* -i : CNN Fear And Greed indicator or index. From Junk Bond Demand, Market Volatility, Put and Call Options, Market
|
||||||
|
Momentum Stock Price, Strength, Stock Price Breadth, Safe Heaven Demand, and Index. Default: None, shows all.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
<img width="962" alt="Captura de ecrã 2021-06-20, às 19 18 12" src="https://user-images.githubusercontent.com/25267873/122684256-4a184380-d1fc-11eb-939c-d8007310324d.png">
|
<img width="962" alt="Captura de ecrã 2021-06-20, às 19 18 12" src="https://user-images.githubusercontent.com/25267873/122684256-4a184380-d1fc-11eb-939c-d8007310324d.png">
|
||||||
|
|
||||||
|
|
||||||
## events <a name="events"></a>
|
## events <a name="events"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: events [-c {NZ,AU,ERL,CA,EU,US,JP,CN,GB,CH}] [-i {low,medium,high,all}] [-n NUM]
|
usage: events [-c {NZ,AU,ERL,CA,EU,US,JP,CN,GB,CH}] [-i {low,medium,high,all}] [-n NUM]
|
||||||
```
|
```
|
||||||
|
|
||||||
Output economy impact calendar impact events. [Source: https://finnhub.io]
|
Output economy impact calendar impact events. [Source: <https://finnhub.io>]
|
||||||
|
|
||||||
* -c : Country from where to get economy calendar impact events, between NZ,AU,ERL,CA,EU,US,JP,CN,GB,CH. Default: US.
|
* -c : Country from where to get economy calendar impact events, between NZ,AU,ERL,CA,EU,US,JP,CN,GB,CH. Default: US.
|
||||||
* -i : Impact of the economy event, between low,medium,high,all. Default: all.
|
* -i : Impact of the economy event, between low,medium,high,all. Default: all.
|
||||||
@@ -72,15 +75,16 @@ Output economy impact calendar impact events. [Source: https://finnhub.io]
|
|||||||
|
|
||||||
<img width="1055" alt="Captura de ecrã 2021-05-02, às 19 51 47" src="https://user-images.githubusercontent.com/25267873/116824200-def9ab80-ab80-11eb-948a-48a94f662b53.png">
|
<img width="1055" alt="Captura de ecrã 2021-05-02, às 19 51 47" src="https://user-images.githubusercontent.com/25267873/116824200-def9ab80-ab80-11eb-948a-48a94f662b53.png">
|
||||||
|
|
||||||
|
|
||||||
## fred <a name="fred"></a>
|
## fred <a name="fred"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: fred [-i SERIES_ID] [-s START_DATE] [-t]
|
usage: fred [-i SERIES_ID] [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
|
|
||||||
Display customized Federal Reserve Economic Data (FRED) from https://fred.stlouisfed.org. It is possible to display multiple series.
|
Display customized Federal Reserve Economic Data (FRED) from <https://fred.stlouisfed.org>. It is possible to display
|
||||||
|
multiple series.
|
||||||
|
|
||||||
* -i : FRED Series ID from https://fred.stlouisfed.org. For multiple series use: `fred series1,series2,series3`
|
* -i : FRED Series ID from <https://fred.stlouisfed.org>. For multiple series use: `fred series1,series2,series3`
|
||||||
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
|
* -s : Starting date (YYYY-MM-DD) of data. Default: 2019-01-01.
|
||||||
* -t : Only output text data.
|
* -t : Only output text data.
|
||||||
|
|
||||||
@@ -88,9 +92,8 @@ Example: `fred gdp,t10yie,cpiaucsl`
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## vixcls <a name="vixcls"></a>
|
## vixcls <a name="vixcls"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: vixcls [-s START_DATE] [-t]
|
usage: vixcls [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -102,8 +105,8 @@ Volatility Index
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## gdp <a name="gdp"></a>
|
## gdp <a name="gdp"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: gdp [-s START_DATE] [-t]
|
usage: gdp [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -115,8 +118,8 @@ Gross Domestic Product
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## unrate <a name="unrate"></a>
|
## unrate <a name="unrate"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: unrate [-s START_DATE] [-t]
|
usage: unrate [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -128,8 +131,8 @@ Unemployment Rate
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## dgs1 <a name="dgs1"></a>
|
## dgs1 <a name="dgs1"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: dgs1 [-s START_DATE] [-t]
|
usage: dgs1 [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -141,8 +144,8 @@ usage: dgs1 [-s START_DATE] [-t]
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## dgs5 <a name="dgs5"></a>
|
## dgs5 <a name="dgs5"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: dgs5 [-s START_DATE] [-t]
|
usage: dgs5 [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -154,8 +157,8 @@ usage: dgs5 [-s START_DATE] [-t]
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## dgs10 <a name="dgs10"></a>
|
## dgs10 <a name="dgs10"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: dgs10 [-s START_DATE] [-t]
|
usage: dgs10 [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -167,8 +170,8 @@ usage: dgs10 [-s START_DATE] [-t]
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## dgs30 <a name="dgs30"></a>
|
## dgs30 <a name="dgs30"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: dgs30 [-s START_DATE] [-t]
|
usage: dgs30 [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -180,8 +183,8 @@ usage: dgs30 [-s START_DATE] [-t]
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## mortgage30us <a name="mortgage30us"></a>
|
## mortgage30us <a name="mortgage30us"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: mortgage30us [-s START_DATE] [-t]
|
usage: mortgage30us [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -193,8 +196,8 @@ usage: mortgage30us [-s START_DATE] [-t]
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## fedfunds <a name="fedfunds"></a>
|
## fedfunds <a name="fedfunds"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: fedfunds [-s START_DATE] [-t]
|
usage: fedfunds [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -206,8 +209,8 @@ Effective Federal Funds Rate
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## aaa <a name="aaa"></a>
|
## aaa <a name="aaa"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: aaa [-s START_DATE] [-t]
|
usage: aaa [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -219,8 +222,8 @@ Moody's Seasoned AAA Corporate Bond Yield
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## dexcaus <a name="dexcaus"></a>
|
## dexcaus <a name="dexcaus"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: dexcaus [-s START_DATE] [-t]
|
usage: dexcaus [-s START_DATE] [-t]
|
||||||
```
|
```
|
||||||
@@ -233,57 +236,65 @@ Canada / U.S. Foreign Exchange Rate (CAD per 1 USD)
|
|||||||

|

|
||||||
|
|
||||||
# WSJ <a name="wsj"></a>
|
# WSJ <a name="wsj"></a>
|
||||||
|
|
||||||
The following functions are meant to take the information from the [WSJ Market Data Page](https://www.wsj.com/market-data)
|
The following functions are meant to take the information from the [WSJ Market Data Page](https://www.wsj.com/market-data)
|
||||||
|
|
||||||
## overview <a name="overview"></a>
|
## overview <a name="overview"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: overview
|
usage: overview
|
||||||
```
|
```
|
||||||
|
|
||||||
Market overview
|
Market overview
|
||||||
|
|
||||||
<img width="943" alt="overview" src="https://user-images.githubusercontent.com/25267873/127777489-325b2d70-7f35-4efe-bee9-0f6e8de232b0.png">
|
<img width="943" alt="overview" src="https://user-images.githubusercontent.com/25267873/127777489-325b2d70-7f35-4efe-bee9-0f6e8de232b0.png">
|
||||||
|
|
||||||
|
|
||||||
## indices <a name="indices"></a>
|
## indices <a name="indices"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: indices
|
usage: indices
|
||||||
```
|
```
|
||||||
|
|
||||||
US indices overview
|
US indices overview
|
||||||
|
|
||||||
<img width="947" alt="indices" src="https://user-images.githubusercontent.com/25267873/127777487-d7d70600-ba07-446b-8609-725b93fe5c89.png">
|
<img width="947" alt="indices" src="https://user-images.githubusercontent.com/25267873/127777487-d7d70600-ba07-446b-8609-725b93fe5c89.png">
|
||||||
|
|
||||||
|
|
||||||
## futures <a name="futures"></a>
|
## futures <a name="futures"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: futures
|
usage: futures
|
||||||
```
|
```
|
||||||
|
|
||||||
Top futures/commodities overview
|
Top futures/commodities overview
|
||||||
|
|
||||||
<img width="949" alt="futures" src="https://user-images.githubusercontent.com/25267873/127777482-4032c6da-7739-49d9-a5e6-83f8260baac0.png">
|
<img width="949" alt="futures" src="https://user-images.githubusercontent.com/25267873/127777482-4032c6da-7739-49d9-a5e6-83f8260baac0.png">
|
||||||
|
|
||||||
|
|
||||||
## us_bonds <a name="us_bonds"></a>
|
## us_bonds <a name="us_bonds"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: us_bonds
|
usage: us_bonds
|
||||||
```
|
```
|
||||||
|
|
||||||
US bonds overview
|
US bonds overview
|
||||||
|
|
||||||
<img width="949" alt="us_bonds" src="https://user-images.githubusercontent.com/25267873/127777484-85384a7c-d7f0-4fd8-875d-9739dc9d6371.png">
|
<img width="949" alt="us_bonds" src="https://user-images.githubusercontent.com/25267873/127777484-85384a7c-d7f0-4fd8-875d-9739dc9d6371.png">
|
||||||
|
|
||||||
|
|
||||||
## gl_bonds <a name="gl_bonds"></a>
|
## gl_bonds <a name="gl_bonds"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: gl_bonds
|
usage: gl_bonds
|
||||||
```
|
```
|
||||||
|
|
||||||
Global bonds overview
|
Global bonds overview
|
||||||
|
|
||||||
<img width="937" alt="gl_bonds" src="https://user-images.githubusercontent.com/25267873/127777486-40239a41-92bf-410d-b8d8-e1fe85bbea25.png">
|
<img width="937" alt="gl_bonds" src="https://user-images.githubusercontent.com/25267873/127777486-40239a41-92bf-410d-b8d8-e1fe85bbea25.png">
|
||||||
|
|
||||||
|
|
||||||
## currencies <a name="currencies"></a>
|
## currencies <a name="currencies"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: currencies
|
usage: currencies
|
||||||
```
|
```
|
||||||
|
|
||||||
Global currencies overview
|
Global currencies overview
|
||||||
|
|
||||||
<img width="945" alt="currencies" src="https://user-images.githubusercontent.com/25267873/127777481-cf9ab6a8-5e9a-4954-a6dc-0b09981e7743.png">
|
<img width="945" alt="currencies" src="https://user-images.githubusercontent.com/25267873/127777481-cf9ab6a8-5e9a-4954-a6dc-0b09981e7743.png">
|
||||||
|
|||||||
48
gamestonk_terminal/etf/README.md
vendored
48
gamestonk_terminal/etf/README.md
vendored
@@ -1,4 +1,5 @@
|
|||||||
# ETF
|
# ETF
|
||||||
|
|
||||||
Menu for Exchange Traded Funds.
|
Menu for Exchange Traded Funds.
|
||||||
|
|
||||||
Data is currently scraped from StockAnalysis.com/etf
|
Data is currently scraped from StockAnalysis.com/etf
|
||||||
@@ -15,6 +16,7 @@ Data is currently scraped from StockAnalysis.com/etf
|
|||||||
* screen ETFs
|
* screen ETFs
|
||||||
|
|
||||||
[WSJ](#WSJ)
|
[WSJ](#WSJ)
|
||||||
|
|
||||||
* [gainers](#gainers)
|
* [gainers](#gainers)
|
||||||
* show top gainers
|
* show top gainers
|
||||||
* [decliners](#decliners)
|
* [decliners](#decliners)
|
||||||
@@ -23,20 +25,26 @@ Data is currently scraped from StockAnalysis.com/etf
|
|||||||
* show most active
|
* show most active
|
||||||
|
|
||||||
## web <a name="web"></a>
|
## web <a name="web"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: web
|
usage: web
|
||||||
```
|
```
|
||||||
Opens StockAnalysis.com/etf. This site shows all avalaiable ETFs (currently > 2800).
|
|
||||||
|
Opens StockAnalysis.com/etf. This site shows all available ETFs (currently > 2800).
|
||||||
|
|
||||||
## search <a name="search"></a>
|
## search <a name="search"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: search [-e --etf] [--export {csv,json,xlsx}]
|
usage: search [-e --etf] [--export {csv,json,xlsx}]
|
||||||
```
|
```
|
||||||
|
|
||||||
Search for ETFs matching
|
Search for ETFs matching
|
||||||
|
|
||||||
* -e/--etf : Name to search for. Can be a company or other search term
|
* -e/--etf : Name to search for. Can be a company or other search term
|
||||||
* --export {csv,json,xlsx} : Export to the selected file
|
* --export {csv,json,xlsx} : Export to the selected file
|
||||||
|
|
||||||
Example Usage: Search for all ETFs that deal with AI
|
Example Usage: Search for all ETFs that deal with AI
|
||||||
|
|
||||||
```python
|
```python
|
||||||
(✨) (etf)> search artificial intelligence
|
(✨) (etf)> search artificial intelligence
|
||||||
BOTZ - Global X Robotics & Artificial Intelligence ETF
|
BOTZ - Global X Robotics & Artificial Intelligence ETF
|
||||||
@@ -45,23 +53,29 @@ ROBT - First Trust Nasdaq Artificial Intelligence and Robotics ETF
|
|||||||
THNQ - ROBO Global Artificial Intelligence ETF
|
THNQ - ROBO Global Artificial Intelligence ETF
|
||||||
UBOT - Daily Robotics, Artificial Intelligence & Automation Index Bull 3X Shares
|
UBOT - Daily Robotics, Artificial Intelligence & Automation Index Bull 3X Shares
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that this searches for exact strings in the ETF name. Searching for SPY will return nothing.
|
Note that this searches for exact strings in the ETF name. Searching for SPY will return nothing.
|
||||||
|
|
||||||
## overview <a name="overview"></a>
|
## overview <a name="overview"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: overview [-e --etf] [--export {csv,json,xlsx}]
|
usage: overview [-e --etf] [--export {csv,json,xlsx}]
|
||||||
```
|
```
|
||||||
|
|
||||||
* -e/--etf : ETF to get data for
|
* -e/--etf : ETF to get data for
|
||||||
* --export {csv,json,xlsx} : Export to the selected file
|
* --export {csv,json,xlsx} : Export to the selected file
|
||||||
|
|
||||||
Returns the overview of the ETF. Shows Last Price, Assets, Net Asset Value (NAV), Expense Ratio, PE Ratio, 5Year Beta, Total Dividend and Dividend Yield.
|
Returns the overview of the ETF. Shows Last Price, Assets, Net Asset Value (NAV), Expense Ratio, PE Ratio, 5Year Beta,
|
||||||
|
Total Dividend and Dividend Yield.
|
||||||
|
|
||||||
Example will be a single column from the [compare](#compare) example.
|
Example will be a single column from the [compare](#compare) example.
|
||||||
|
|
||||||
## holdings <a name="holdings"></a>
|
## holdings <a name="holdings"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: overview [-e --etf] [-l --limit] [--export {csv,json,xlsx}]
|
usage: overview [-e --etf] [-l --limit] [--export {csv,json,xlsx}]
|
||||||
```
|
```
|
||||||
|
|
||||||
* -e/--etf : Name of ETF to get data for.
|
* -e/--etf : Name of ETF to get data for.
|
||||||
* -l/--limit : Number of assets to show. Max 200. Defaults to 20.
|
* -l/--limit : Number of assets to show. Max 200. Defaults to 20.
|
||||||
* --export {csv,json,xlsx} : Export to the selected file
|
* --export {csv,json,xlsx} : Export to the selected file
|
||||||
@@ -69,7 +83,8 @@ usage: overview [-e --etf] [-l --limit] [--export {csv,json,xlsx}]
|
|||||||
Returns the top holdings in the ETF. Shows percentage and total shares held.
|
Returns the top holdings in the ETF. Shows percentage and total shares held.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
```
|
|
||||||
|
```text
|
||||||
(✨) (etf)> holdings spy -l 5
|
(✨) (etf)> holdings spy -l 5
|
||||||
╒════╤══════════╤════════════╤═════════════╕
|
╒════╤══════════╤════════════╤═════════════╕
|
||||||
│ │ Ticker │ % of ETF │ Shares │
|
│ │ Ticker │ % of ETF │ Shares │
|
||||||
@@ -87,17 +102,19 @@ Example:
|
|||||||
```
|
```
|
||||||
|
|
||||||
## compare <a name="compare"></a>
|
## compare <a name="compare"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: compare [-e --etfs] [--export {csv,json,xlsx}]
|
usage: compare [-e --etfs] [--export {csv,json,xlsx}]
|
||||||
```
|
```
|
||||||
|
|
||||||
* -e/--etfs : ETFs to compare. Input as comma separated (ETF1,ETF2,..)
|
* -e/--etfs : ETFs to compare. Input as comma separated (ETF1,ETF2,..)
|
||||||
* --export {csv,json,xlsx} : Export to the selected file
|
* --export {csv,json,xlsx} : Export to the selected file
|
||||||
|
|
||||||
Campares the overview of different ETFs.
|
Compares the overview of different ETFs.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
```
|
```text
|
||||||
(✨) (etf)> compare spy,qqq,voo,doge
|
(✨) (etf)> compare spy,qqq,voo,doge
|
||||||
DOGE not found
|
DOGE not found
|
||||||
╒════════════════╤══════════╤══════════╤══════════╕
|
╒════════════════╤══════════╤══════════╤══════════╕
|
||||||
@@ -120,7 +137,9 @@ DOGE not found
|
|||||||
│ Dividend Yield │ 1.34% │ 0.54% │ 1.41% │
|
│ Dividend Yield │ 1.34% │ 0.54% │ 1.41% │
|
||||||
╘════════════════╧══════════╧══════════╧══════════╛
|
╘════════════════╧══════════╧══════════╧══════════╛
|
||||||
```
|
```
|
||||||
|
|
||||||
## screener <a name="screener"></a>
|
## screener <a name="screener"></a>
|
||||||
|
|
||||||
````python
|
````python
|
||||||
usage: screener [-n --num] [--export {csv,json,xlsx}] [-h]
|
usage: screener [-n --num] [--export {csv,json,xlsx}] [-h]
|
||||||
````
|
````
|
||||||
@@ -129,11 +148,13 @@ usage: screener [-n --num] [--export {csv,json,xlsx}] [-h]
|
|||||||
* --export {csv,json,xlsx} : Export to the selected file
|
* --export {csv,json,xlsx} : Export to the selected file
|
||||||
|
|
||||||
Screen ETFs based on the overview data from stockanalysis.com. This data is scraped hourly during market hours.
|
Screen ETFs based on the overview data from stockanalysis.com. This data is scraped hourly during market hours.
|
||||||
Repo can be found at https://github.com/jmaslek/etf_scraper. For screeners with many results (exceeding the `--num` flag)
|
Repo can be found at <https://github.com/jmaslek/etf_scraper>. For screeners with many results (exceeding the `--num` flag)
|
||||||
, the console will display a random subset of them.
|
, the console will display a random subset of them.
|
||||||
|
|
||||||
Note that to use the config file, locate the desired data column then change MIN and MAX. Make sure unused columns are set to None.
|
Note that to use the config file, locate the desired data column then change MIN and MAX. Make sure unused columns are
|
||||||
Example which will screen for ETFs the Opened between $45 and $57 (note the available data is Open and Previous Close):
|
set to None. Example which will screen for ETFs the Opened between $45 and $57 (note the available data is Open and
|
||||||
|
Previous Close):
|
||||||
|
|
||||||
```python
|
```python
|
||||||
[OPEN]
|
[OPEN]
|
||||||
MIN = 45
|
MIN = 45
|
||||||
@@ -163,17 +184,18 @@ MAX = 57
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
```text
|
||||||
```
|
|
||||||
# WSJ <a name="wsj"></a>
|
# WSJ <a name="wsj"></a>
|
||||||
The following functions atake the information from the [WSJ Market Data Page](https://www.wsj.com/market-data)
|
The following functions take the information from the [WSJ Market Data Page](https://www.wsj.com/market-data)
|
||||||
|
|
||||||
## gainers <a name="gainers"></a>
|
## gainers <a name="gainers"></a>
|
||||||
|
|
||||||
```python
|
```python
|
||||||
usage: gainers [-n NUM] [--export {csv,json,xlsx}] [-h]
|
usage: gainers [-n NUM] [--export {csv,json,xlsx}] [-h]
|
||||||
```
|
```
|
||||||
|
|
||||||
Shows top gaining ETFs
|
Shows top gaining ETFs
|
||||||
|
|
||||||
* -n/--num: Number to show. Defaults to 25, which is the max provided
|
* -n/--num: Number to show. Defaults to 25, which is the max provided
|
||||||
* --export: Export data to one of {csv, json, xlsx}.
|
* --export: Export data to one of {csv, json, xlsx}.
|
||||||
|
|
||||||
@@ -182,7 +204,9 @@ Shows top gaining ETFs
|
|||||||
```python
|
```python
|
||||||
usage: decliners [-n NUM] [--export {csv,json,xlsx}] [-h]
|
usage: decliners [-n NUM] [--export {csv,json,xlsx}] [-h]
|
||||||
```
|
```
|
||||||
|
|
||||||
Shows highest declining ETFs
|
Shows highest declining ETFs
|
||||||
|
|
||||||
* -n/--num: Number to show. Defaults to 25, which is the max provided
|
* -n/--num: Number to show. Defaults to 25, which is the max provided
|
||||||
* --export: Export data to one of {csv, json, xlsx}.
|
* --export: Export data to one of {csv, json, xlsx}.
|
||||||
|
|
||||||
@@ -191,6 +215,8 @@ Shows highest declining ETFs
|
|||||||
```python
|
```python
|
||||||
usage: active [-n NUM] [--export {csv,json,xlsx}] [-h]
|
usage: active [-n NUM] [--export {csv,json,xlsx}] [-h]
|
||||||
```
|
```
|
||||||
|
|
||||||
Shows most active ETFs
|
Shows most active ETFs
|
||||||
|
|
||||||
* -n/--num: Number to show. Defaults to 25, which is the max provided
|
* -n/--num: Number to show. Defaults to 25, which is the max provided
|
||||||
* --export: Export data to one of {csv, json, xlsx}.
|
* --export: Export data to one of {csv, json, xlsx}.
|
||||||
|
|||||||
82
gamestonk_terminal/forex/README.md
vendored
82
gamestonk_terminal/forex/README.md
vendored
@@ -40,11 +40,14 @@ This menu utilizes oanda to enable support for trading forex.
|
|||||||
* This menu aims to extrapolate behavioural analysis regarding a pre-loaded forex instrument.
|
* This menu aims to extrapolate behavioural analysis regarding a pre-loaded forex instrument.
|
||||||
|
|
||||||
## summary <a name ="summary"></a>
|
## summary <a name ="summary"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: summary
|
usage: summary
|
||||||
```
|
```
|
||||||
|
|
||||||
Displays current balance, net asset value, unrealized P/L, total P/L, count of open trades, how much margin is available, how much margin you've used, the margin call value, the percent of margin until closeout, and the total position value.
|
Displays current balance, net asset value, unrealized P/L, total P/L, count of open trades, how much margin is
|
||||||
|
available, how much margin you've used, the margin call value, the percent of margin until closeout, and the total
|
||||||
|
position value.
|
||||||
|
|
||||||
## calendar <a name="calendar"></a>
|
## calendar <a name="calendar"></a>
|
||||||
|
|
||||||
@@ -52,27 +55,37 @@ This menu utilizes oanda to enable support for trading forex.
|
|||||||
usage: calendar [-d DAYS]
|
usage: calendar [-d DAYS]
|
||||||
```
|
```
|
||||||
|
|
||||||
Display information about past or upcoming events up to 30 days before or from todays date. The information includes the Title of the event, the time the event is scheduled, the rated impact, Oanda's forecast, the market forecast, the currency involved, the region from which the event originates, the actual value (for events that have finished), and the previous value.
|
Display information about past or upcoming events up to 30 days before or from todays date. The information includes
|
||||||
|
the Title of the event, the time the event is scheduled, the rated impact, Oanda's forecast, the market forecast, the
|
||||||
|
currency involved, the region from which the event originates, the actual value (for events that have finished), and
|
||||||
|
the previous value.
|
||||||
|
|
||||||
* -d : The number of days to search (7 is the default, 30 is the maximum that information is provided for). Use a positive value to search for upcoming events and a negative value to search for past events.
|
* -d : The number of days to search (7 is the default, 30 is the maximum that information is provided for). Use a
|
||||||
|
positive value to search for upcoming events and a negative value to search for past events.
|
||||||
|
|
||||||
## list <a name="list"></a>
|
## list <a name="list"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: list [-s STATE] [-c COUNT]
|
usage: list [-s STATE] [-c COUNT]
|
||||||
```
|
```
|
||||||
|
|
||||||
Retrieves a list of orders you've made. It includes the ID, the instrument, the number of units, the price, the state of the order, and the type of order.
|
Retrieves a list of orders you've made. It includes the ID, the instrument, the number of units, the price, the state
|
||||||
|
of the order, and the type of order.
|
||||||
|
|
||||||
* -s : The state of the orders to filter. You can specify: pending, filled, triggered, canceled or all. (default=all)
|
* -s : The state of the orders to filter. You can specify: pending, filled, triggered, canceled or all. (default=all)
|
||||||
* -c : The number of orders to retrieve. (default = 20)
|
* -c : The number of orders to retrieve. (default = 20)
|
||||||
|
|
||||||
## pending <a name="pending"></a>
|
## pending <a name="pending"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: pending
|
usage: pending
|
||||||
```
|
```
|
||||||
A shortcut to list the pending orders for your account. It includes the ID, the instrument, the price, the number of units, the time the order was created and the time in force.
|
|
||||||
|
A shortcut to list the pending orders for your account. It includes the ID, the instrument, the price, the number of
|
||||||
|
units, the time the order was created and the time in force.
|
||||||
|
|
||||||
## cancel <a name="cancel"></a>
|
## cancel <a name="cancel"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: cancel [-i ORDERID]
|
usage: cancel [-i ORDERID]
|
||||||
```
|
```
|
||||||
@@ -82,30 +95,40 @@ Cancel a pending order by its order ID.
|
|||||||
* -i : Specify the order ID. You don't need to include this, simply include the order number.
|
* -i : Specify the order ID. You don't need to include this, simply include the order number.
|
||||||
|
|
||||||
## positions <a name="positions"></a>
|
## positions <a name="positions"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: positions
|
usage: positions
|
||||||
```
|
```
|
||||||
|
|
||||||
Lists your open positions. The information includes the instrument, the current number of long units, the total profit/loss from long positions for the account, the unrealized profit/loss from long positions, the current number of short units, the total profit/loss from short positions for the account, and the unrealized profit/loss from short positions.
|
Lists your open positions. The information includes the instrument, the current number of long units, the total
|
||||||
|
profit/loss from long positions for the account, the unrealized profit/loss from long positions, the current number of
|
||||||
|
short units, the total profit/loss from short positions for the account, and the unrealized profit/loss from short
|
||||||
|
positions.
|
||||||
|
|
||||||
## trades <a name="trades"></a>
|
## trades <a name="trades"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: trades
|
usage: trades
|
||||||
```
|
```
|
||||||
|
|
||||||
Lists the current open trades for your account. The information includes the ID, the instrument, the initial units opened for the trade, the current number of units open for the trade, it's entry price, and the unrealized profit/loss for the trade.
|
Lists the current open trades for your account. The information includes the ID, the instrument, the initial units
|
||||||
|
opened for the trade, the current number of units open for the trade, it's entry price, and the unrealized profit/loss
|
||||||
|
for the trade.
|
||||||
|
|
||||||
## closetrade <a name="closetrade"></a>
|
## closetrade <a name="closetrade"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: closetrade [-i ORDERID] [-u UNITS]
|
usage: closetrade [-i ORDERID] [-u UNITS]
|
||||||
```
|
```
|
||||||
|
|
||||||
Closes a trade by ID. Displays the order ID closed, the instrument, the number of units that were closed, the price, and the profit/loss
|
Closes a trade by ID. Displays the order ID closed, the instrument, the number of units that were closed, the price,
|
||||||
|
and the profit/loss
|
||||||
|
|
||||||
* -i : Specify the order ID. You don't need to include this, simply include the order number.
|
* -i : Specify the order ID. You don't need to include this, simply include the order number.
|
||||||
* -u : Specify the number of units to close for that trade. (default=all)
|
* -u : Specify the number of units to close for that trade. (default=all)
|
||||||
|
|
||||||
## load <a name="load"></a>
|
## load <a name="load"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: load [-i INSTRUMENT]
|
usage: load [-i INSTRUMENT]
|
||||||
```
|
```
|
||||||
@@ -115,24 +138,38 @@ Specify the instrument to use in the format EUR_USD
|
|||||||
* -i : Specify the instrument. You don't need to include this, simply include the instrument.
|
* -i : Specify the instrument. You don't need to include this, simply include the instrument.
|
||||||
|
|
||||||
## candles <a name="candles"></a>
|
## candles <a name="candles"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: candles [-g GRANULARITY] [-c CANDLECOUNT] [-abcCeorsv]
|
usage: candles [-g GRANULARITY] [-c CANDLECOUNT] [-abcCeorsv]
|
||||||
```
|
```
|
||||||
|
|
||||||
Retrieve a candlestick chart for the currently loaded instrument. Not a live chart.
|
Retrieve a candlestick chart for the currently loaded instrument. Not a live chart.
|
||||||
|
|
||||||
* -g : Specify the granularity, which is the timeframe each candle represents. The available granularities are Seconds: S5, S10, S15, S30 Minutes: M1, M2, M4, M5, M10, M15, M30 Hours: H1, H2, H3, H4, H6, H8, H12 Day: D, Week: W Month: M. (default=D)
|
* -g : Specify the granularity, which is the timeframe each candle represents. The available granularities are Seconds:
|
||||||
|
S5, S10, S15, S30 Minutes: M1, M2, M4, M5, M10, M15, M30 Hours: H1, H2, H3, H4, H6, H8, H12 Day: D, Week: W Month: M. (default=D)
|
||||||
* -c : Specify the number of candles to retrieve. (default=180)
|
* -c : Specify the number of candles to retrieve. (default=180)
|
||||||
* -a : Adds AD (Accumulation/Distribution Index) to the chart. AD is a cumulative indicator that uses volume and price to assess whether a stock is being accumulated or distributed. This provides insight into how strong a trend is. [Investopedia](#https://www.investopedia.com/terms/a/accumulationdistribution.asp)
|
* -a : Adds AD (Accumulation/Distribution Index) to the chart. AD is a cumulative indicator that uses volume and price
|
||||||
* -b : Adds Bollinger Bands to the chart. Bollinger bands are a set of trendlines plotted two standard deviations (positively and negatively) away from a simple moving average of a security's price. [Investopedia](#https://www.investopedia.com/terms/b/bollingerbands.asp)
|
to assess whether a stock is being accumulated or distributed. This provides insight into how strong a trend is.
|
||||||
* -C : Adds CCI (Commodity Channel Index) to the chart. CCI is a momentum-based oscillator used to help determine when an investment vehicle is reaching a condition of being overbought or oversold. (default=14) [Investopedia](#https://www.investopedia.com/terms/c/commoditychannelindex.asp)
|
[Investopedia](#https://www.investopedia.com/terms/a/accumulationdistribution.asp)
|
||||||
* -e : Adds EMA (Exponential Moving Average) to the chart. EMA is a moving average that places a greater weight and significance on the most recent data points. (default=10) [Investopedia](#https://www.investopedia.com/terms/e/ema.asp)
|
* -b : Adds Bollinger Bands to the chart. Bollinger bands are a set of trendlines plotted two standard deviations
|
||||||
* -o : Adds OBV (On Balance Volume) to the chart. OBV is a momentum indicator that uses volume flow to predict changes in price. [Investopedia](#https://www.investopedia.com/terms/o/onbalancevolume.asp)
|
(positively and negatively) away from a simple moving average of a security's price.
|
||||||
* -r : Adds RSI (Relative Strength Index) to the chart. RSI is a momentum indicator that measures the magnitude of recent price changes to evaluate overbought or oversold conditions. (default=14) [Investopedia](#https://www.investopedia.com/terms/r/rsi.asp)
|
[Investopedia](#https://www.investopedia.com/terms/b/bollingerbands.asp)
|
||||||
* -s : Adds SMA (Simple Moving Average) to the chart. SMA calculates the average of a selected range of prices, usually closing prices, by the number of periods in that range. (defaults= 20, 50) [Investopedia](#https://www.investopedia.com/terms/s/sma.asp)
|
* -C : Adds CCI (Commodity Channel Index) to the chart. CCI is a momentum-based oscillator used to help determine when
|
||||||
* -v : Adds VWAP (Volume Weighted Average Price) to the chart. VWAP gives the average price a security has traded at throughout the day, based on both volume and price. [Investopedia](#https://www.investopedia.com/terms/v/vwap.asp)
|
an investment vehicle is reaching a condition of being overbought or oversold. (default=14)
|
||||||
|
[Investopedia](#https://www.investopedia.com/terms/c/commoditychannelindex.asp)
|
||||||
|
* -e : Adds EMA (Exponential Moving Average) to the chart. EMA is a moving average that places a greater weight and
|
||||||
|
significance on the most recent data points. (default=10) [Investopedia](#https://www.investopedia.com/terms/e/ema.asp)
|
||||||
|
* -o : Adds OBV (On Balance Volume) to the chart. OBV is a momentum indicator that uses volume flow to predict changes
|
||||||
|
in price. [Investopedia](#https://www.investopedia.com/terms/o/onbalancevolume.asp)
|
||||||
|
* -r : Adds RSI (Relative Strength Index) to the chart. RSI is a momentum indicator that measures the magnitude of
|
||||||
|
recent price changes to evaluate overbought or oversold conditions. (default=14) [Investopedia](#https://www.investopedia.com/terms/r/rsi.asp)
|
||||||
|
* -s : Adds SMA (Simple Moving Average) to the chart. SMA calculates the average of a selected range of prices, usually
|
||||||
|
closing prices, by the number of periods in that range. (defaults= 20, 50) [Investopedia](#https://www.investopedia.com/terms/s/sma.asp)
|
||||||
|
* -v : Adds VWAP (Volume Weighted Average Price) to the chart. VWAP gives the average price a security has traded at
|
||||||
|
throughout the day, based on both volume and price. [Investopedia](#https://www.investopedia.com/terms/v/vwap.asp)
|
||||||
|
|
||||||
## price <a name="price"></a>
|
## price <a name="price"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: price
|
usage: price
|
||||||
```
|
```
|
||||||
@@ -140,6 +177,7 @@ usage: price
|
|||||||
Gets the current price for the currently loaded instrument
|
Gets the current price for the currently loaded instrument
|
||||||
|
|
||||||
## order <a name="order"></a>
|
## order <a name="order"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: order -u UNITS -p PRICE
|
usage: order -u UNITS -p PRICE
|
||||||
```
|
```
|
||||||
@@ -150,15 +188,19 @@ Places a limit order for the specified number of units at the specified price. B
|
|||||||
* -p : Specify the price for the limit order.
|
* -p : Specify the price for the limit order.
|
||||||
|
|
||||||
## orderbook <a name="orderbook"></a>
|
## orderbook <a name="orderbook"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: orderbook
|
usage: orderbook
|
||||||
```
|
```
|
||||||
|
|
||||||
Plots the current orderbook for loaded instrument if one is provided by Oanda. Not a live chart.
|
Plots the current orderbook for loaded instrument if one is provided by Oanda. Not a live chart.
|
||||||
|
|
||||||
## positionbook <a name="positionbook"></a>
|
## positionbook <a name="positionbook"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: positionbook
|
usage: positionbook
|
||||||
```
|
```
|
||||||
|
|
||||||
Plots the current positionbook for the loaded instrument if one is provided by Oanda. Not a live chart.
|
Plots the current positionbook for the loaded instrument if one is provided by Oanda. Not a live chart.
|
||||||
|
|
||||||
## news <a name="news"></a>
|
## news <a name="news"></a>
|
||||||
@@ -181,9 +223,11 @@ Print top stock's due diligence from other users. [Source: Reddit]
|
|||||||
|
|
||||||
* -l : limit of posts to retrieve
|
* -l : limit of posts to retrieve
|
||||||
* -d : number of prior days to look for
|
* -d : number of prior days to look for
|
||||||
* -a : "search through all flairs (apart from Yolo and Meme). Default False (i.e. use flairs: DD, technical analysis, Catalyst, News, Advice, Chart, Charts and Setups, Fundamental Analysis, Forex, Trade Idea)
|
* -a : "search through all flairs (apart from Yolo and Meme). Default False (i.e. use flairs: DD, technical analysis,
|
||||||
|
Catalyst, News, Advice, Chart, Charts and Setups, Fundamental Analysis, Forex, Trade Idea)
|
||||||
|
|
||||||
## eda <a name="eda"></a>
|
## eda <a name="eda"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: eda
|
usage: eda
|
||||||
```
|
```
|
||||||
@@ -191,7 +235,9 @@ usage: eda
|
|||||||
Access the exploratory data analysis menu.
|
Access the exploratory data analysis menu.
|
||||||
|
|
||||||
## ba <a name="ba"></a>
|
## ba <a name="ba"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
usage: ba
|
usage: ba
|
||||||
```
|
```
|
||||||
|
|
||||||
Access the behavioural analysis menu.
|
Access the behavioural analysis menu.
|
||||||
|
|||||||
26
gamestonk_terminal/options/presets/README.md
vendored
26
gamestonk_terminal/options/presets/README.md
vendored
@@ -11,41 +11,45 @@
|
|||||||
|
|
||||||
2. There should be a `README.md` file and multiple `.ini` files. One of these `.ini` files should be named `template.ini`.
|
2. There should be a `README.md` file and multiple `.ini` files. One of these `.ini` files should be named `template.ini`.
|
||||||
|
|
||||||
<img width="470" alt="Captura de ecrã 2021-06-28, às 22 00 14" src="https://user-images.githubusercontent.com/25267873/123706416-2be7be80-d860-11eb-9255-58787e264f49.png">
|
<img width="470" alt="Image1" src="https://user-images.githubusercontent.com/25267873/123706416-2be7be80-d860-11eb-9255-58787e264f49.png">
|
||||||
|
|
||||||
3. Copy the `template.ini` file and paste it in the same directory.
|
3. Copy the `template.ini` file and paste it in the same directory.
|
||||||
4. Rename that file to something you find meaningful, e.g. `my_own_filter.ini`.
|
4. Rename that file to something you find meaningful, e.g. `my_own_filter.ini`.
|
||||||
|
|
||||||
<img width="450" alt="Captura de ecrã 2021-06-28, às 22 04 27" src="https://user-images.githubusercontent.com/25267873/123706424-2db18200-d860-11eb-9523-e4647a073645.png">
|
<img width="450" alt="Image2" src="https://user-images.githubusercontent.com/25267873/123706424-2db18200-d860-11eb-9523-e4647a073645.png">
|
||||||
|
|
||||||
5. Open the file you just renamed (e.g. `my_own_filter.ini`), and set the parameters you want to filter.
|
5. Open the file you just renamed (e.g. `my_own_filter.ini`), and set the parameters you want to filter.
|
||||||
|
|
||||||
<img width="472" alt="Captura de ecrã 2021-06-28, às 22 08 16" src="https://user-images.githubusercontent.com/25267873/123706427-2e4a1880-d860-11eb-8523-24654013d3e4.png">
|
<img width="472" alt="Image3" src="https://user-images.githubusercontent.com/25267873/123706427-2e4a1880-d860-11eb-8523-24654013d3e4.png">
|
||||||
|
|
||||||
6. It may be useful to play with the main source https://ops.syncretism.io since you can tweak these and understand how they influence the outcome of the filtered stocks.
|
6. It may be useful to play with the main source <https://ops.syncretism.io> since you can tweak these and understand
|
||||||
|
how they influence the outcome of the filtered stocks.
|
||||||
|
|
||||||
<img width="1036" alt="Captura de ecrã 2021-06-28, às 22 53 13" src="https://user-images.githubusercontent.com/25267873/123708702-c85f9000-d863-11eb-835e-13ea07e45e04.png">
|
<img width="1036" alt="Image4" src="https://user-images.githubusercontent.com/25267873/123708702-c85f9000-d863-11eb-835e-13ea07e45e04.png">
|
||||||
|
|
||||||
7. Update the Author and Description name. E.g.
|
7. Update the Author and Description name. E.g.
|
||||||
|
|
||||||
<img width="462" alt="Captura de ecrã 2021-06-28, às 23 26 26" src="https://user-images.githubusercontent.com/25267873/123711451-6b1a0d80-d868-11eb-9887-3389bbff6514.png">
|
<img width="462" alt="Image5" src="https://user-images.githubusercontent.com/25267873/123711451-6b1a0d80-d868-11eb-9887-3389bbff6514.png">
|
||||||
|
|
||||||
8. Start the terminal, and go to the `> op` menu. In there, you can play with it on the terminal as shown:
|
8. Start the terminal, and go to the `> op` menu. In there, you can play with it on the terminal as shown:
|
||||||
|
|
||||||
* **disp**: Allows to see the screeners available. I.e. all `.ini` files in presets folder.
|
* **disp**: Allows to see the screeners available. I.e. all `.ini` files in presets folder.
|
||||||
* **disp <selected_preset>**: Allows to see the specific parameters set for the preset selected.
|
* **disp <selected_preset>**: Allows to see the specific parameters set for the preset selected.
|
||||||
* **scr <selected_preset>**: Allows to show stocks that are filtered using the selected preset.
|
* **scr <selected_preset>**: Allows to show stocks that are filtered using the selected preset.
|
||||||
* Note: As default, if the user does **scr** this will use the `template.ini` file. So, the user can do some tests with teaking of parameters on the `template.ini` file.
|
* Note: As default, if the user does **scr** this will use the `template.ini` file. So, the user can do some tests
|
||||||
|
with tweaking of parameters on the `template.ini` file.
|
||||||
|
|
||||||
<img width="1220" alt="Captura de ecrã 2021-06-28, às 23 28 36" src="https://user-images.githubusercontent.com/25267873/123711622-aa485e80-d868-11eb-8c9f-ed9e6453632b.png">
|
<img width="1220" alt="Image6" src="https://user-images.githubusercontent.com/25267873/123711622-aa485e80-d868-11eb-8c9f-ed9e6453632b.png">
|
||||||
|
|
||||||
9. Share with other Apes. You can do so by either creating yourself a Pull Request with this change, or asking a dev (e.g. @Sexy_Year) on our discord server to add it for you.
|
9. Share with other Apes. You can do so by either creating yourself a Pull Request with this change, or asking a dev
|
||||||
|
(e.g. @Sexy_Year) on our discord server to add it for you.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## template
|
## template
|
||||||
|
|
||||||
* **Author of preset:** GamestonkTerminal
|
* **Author of preset:** GamestonkTerminal
|
||||||
* **Contact:** https://github.com/DidierRLopes/GamestonkTerminal#contacts
|
* **Contact:** <https://github.com/DidierRLopes/GamestonkTerminal#contacts>
|
||||||
* **Description:** Template with all available filters and their options menu. More information can be found in https://ops.syncretism.io/index.html.
|
* **Description:** Template with all available filters and their options menu. More information can be found in <https://ops.syncretism.io/index.html>.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
72
gamestonk_terminal/portfolio/brokers/README.md
vendored
72
gamestonk_terminal/portfolio/brokers/README.md
vendored
@@ -1,52 +1,65 @@
|
|||||||
# BROKERS
|
# BROKERS
|
||||||
|
|
||||||
This page shows the available brokers for loading your holdings. If yours is not listed, please submit a new issue and we will look into adding it.
|
This page shows the available brokers for loading your holdings. If yours is not listed, please submit a new issue and
|
||||||
|
we will look into adding it.
|
||||||
|
|
||||||
Current brokers:
|
Current brokers:
|
||||||
|
|
||||||
* rh : Robinhood
|
* rh : Robinhood
|
||||||
* ally: Ally
|
* ally: Ally
|
||||||
* dg : Degiro
|
* dg : Degiro
|
||||||
|
|
||||||
|
|
||||||
Once this screen is accessed, the first command to be run is
|
Once this screen is accessed, the first command to be run is
|
||||||
````
|
|
||||||
|
```text
|
||||||
login [brokers]
|
login [brokers]
|
||||||
````
|
```
|
||||||
|
|
||||||
The brokers should just be your brokers from the list shown on the first menu. To login to Robinhood, the command is
|
The brokers should just be your brokers from the list shown on the first menu. To login to Robinhood, the command is
|
||||||
````
|
|
||||||
|
```text
|
||||||
login rh
|
login rh
|
||||||
````
|
```
|
||||||
|
|
||||||
To login to both robinhood and alpaca:
|
To login to both robinhood and alpaca:
|
||||||
````
|
|
||||||
|
```text
|
||||||
login rh alp
|
login rh alp
|
||||||
````
|
```
|
||||||
|
|
||||||
After logging in, the help menu will display which brokers you logged into.
|
After logging in, the help menu will display which brokers you logged into.
|
||||||
|
|
||||||
Your login information should be stored as environment variables in [config file](/gamestonk_terminal/config_terminal.py), but check each individual section for specifics.
|
Your login information should be stored as environment variables in [config file](/gamestonk_terminal/config_terminal.py),
|
||||||
|
but check each individual section for specifics.
|
||||||
|
|
||||||
[ROBINHOOD](#ROBINHOOD)
|
[ROBINHOOD](#ROBINHOOD)
|
||||||
|
|
||||||
* [rhhold](#rhhold)
|
* [rhhold](#rhhold)
|
||||||
* Look at current (stock only) holdings
|
* Look at current (stock only) holdings
|
||||||
* [rhhist](#rhhist)
|
* [rhhist](#rhhist)
|
||||||
* Get and plot historical portfolio
|
* Get and plot historical portfolio
|
||||||
|
|
||||||
[ALLY](#ALLY)
|
[ALLY](#ALLY)
|
||||||
|
|
||||||
* [allyhold](#allyhold)
|
* [allyhold](#allyhold)
|
||||||
* Look at Ally Invest Holdings
|
* Look at Ally Invest Holdings
|
||||||
|
|
||||||
[DEGIRO standalone menu](/gamestonk_terminal/brokers/degiro/)
|
[DEGIRO standalone menu](/gamestonk_terminal/brokers/degiro/)
|
||||||
|
|
||||||
[Merge](#Merge)
|
[Merge](#Merge)
|
||||||
|
|
||||||
* [hold](#hold)
|
* [hold](#hold)
|
||||||
* View holdings across all brokers
|
* View holdings across all brokers
|
||||||
|
|
||||||
|
|
||||||
## ROBINHOOD <a name="ROBINHOOD"></a>
|
## ROBINHOOD <a name="ROBINHOOD"></a>
|
||||||
|
|
||||||
Robinhood has Two Factor Authentication, so you will likely be prompted to enter a code that is texted/emailed to you.
|
Robinhood has Two Factor Authentication, so you will likely be prompted to enter a code that is texted/emailed to you.
|
||||||
###NOTE THAT LOGGING IN WILL SAVE A TOKEN TO `os.path.expanduser("~")/.tokens` WHICH CAN BE USED TO LOGIN EVEN IF USER CREDENTIALS ARE INCORRECT.
|
|
||||||
|
**NOTE** THAT LOGGING IN WILL SAVE A TOKEN TO `os.path.expanduser("~")/.tokens` WHICH CAN BE USED TO LOGIN EVEN IF USER
|
||||||
|
CREDENTIALS ARE INCORRECT.
|
||||||
|
|
||||||
In order to login, the [config file](/gamestonk_terminal/config_terminal.py) requires two variables:
|
In order to login, the [config file](/gamestonk_terminal/config_terminal.py) requires two variables:
|
||||||
|
|
||||||
* "GT_RH_USERNAME"
|
* "GT_RH_USERNAME"
|
||||||
* "GT_RH_PASSWORD"
|
* "GT_RH_PASSWORD"
|
||||||
|
|
||||||
@@ -54,9 +67,10 @@ In order to login, the [config file](/gamestonk_terminal/config_terminal.py) req
|
|||||||
|
|
||||||
Displays current holdings to the console:
|
Displays current holdings to the console:
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: rhhold
|
usage: rhhold
|
||||||
````
|
```
|
||||||
|
|
||||||
There are no additional flags. This just prints all current stonks, their last price, previous close, your equity and
|
There are no additional flags. This just prints all current stonks, their last price, previous close, your equity and
|
||||||
the % change from previous close.
|
the % change from previous close.
|
||||||
|
|
||||||
@@ -65,10 +79,14 @@ Example:
|
|||||||

|

|
||||||
|
|
||||||
### rhhist <a name="rhhist"></a>
|
### rhhist <a name="rhhist"></a>
|
||||||
Display your RH portfolio based on provided interval and span. Based on the API data availablility, plotted as a candlestick chart.
|
|
||||||
````
|
Display your RH portfolio based on provided interval and span. Based on the API data availability, plotted as a
|
||||||
|
candlestick chart.
|
||||||
|
|
||||||
|
```text
|
||||||
usage: rhhist [-s --span] [-i --interval]
|
usage: rhhist [-s --span] [-i --interval]
|
||||||
````
|
```
|
||||||
|
|
||||||
* -s/--span : How long to look back. Defaults to the day. Options:
|
* -s/--span : How long to look back. Defaults to the day. Options:
|
||||||
* [day, week, month, 3month, year, 5year, all]
|
* [day, week, month, 3month, year, 5year, all]
|
||||||
* -i/--interval: Data resolution. Defaults to 10minute intervals. Options:
|
* -i/--interval: Data resolution. Defaults to 10minute intervals. Options:
|
||||||
@@ -85,6 +103,7 @@ In order to access your Ally Invest account through the API, you must first acqu
|
|||||||
|
|
||||||
Once you have this, you want to load in the following environment variables (similar to alpaca, the api will access these
|
Once you have this, you want to load in the following environment variables (similar to alpaca, the api will access these
|
||||||
directly from the environment)
|
directly from the environment)
|
||||||
|
|
||||||
* ALLY_CONSUMER_KEY
|
* ALLY_CONSUMER_KEY
|
||||||
* ALLY_CONSUMER_SECRET
|
* ALLY_CONSUMER_SECRET
|
||||||
* ALLY_OAUTH_TOKEN
|
* ALLY_OAUTH_TOKEN
|
||||||
@@ -93,13 +112,16 @@ directly from the environment)
|
|||||||
* This is obtained from your actual account - not through the api application.
|
* This is obtained from your actual account - not through the api application.
|
||||||
|
|
||||||
As of writing this, the ally API does not provide historical portfolio data, so only a holdings option is provided.
|
As of writing this, the ally API does not provide historical portfolio data, so only a holdings option is provided.
|
||||||
### allyhold <a name="allyhold"></a>
|
|
||||||
Show all Ally Invest holdings:
|
|
||||||
````
|
|
||||||
usage : allyhold
|
|
||||||
````
|
|
||||||
No additional flags.
|
|
||||||
|
|
||||||
|
### allyhold <a name="allyhold"></a>
|
||||||
|
|
||||||
|
Show all Ally Invest holdings:
|
||||||
|
|
||||||
|
```text
|
||||||
|
usage : allyhold
|
||||||
|
```
|
||||||
|
|
||||||
|
No additional flags.
|
||||||
|
|
||||||
## Merge <a name="Merge"></a>
|
## Merge <a name="Merge"></a>
|
||||||
|
|
||||||
@@ -109,7 +131,9 @@ viewing holding across all platforms. The PnL is shown for all time (Market Val
|
|||||||
### hold <a name = "hold"></a>
|
### hold <a name = "hold"></a>
|
||||||
|
|
||||||
Show holdings across all brokers that are logged in.
|
Show holdings across all brokers that are logged in.
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: hold
|
usage: hold
|
||||||
````
|
```
|
||||||
|
|
||||||
Currently no additional flags. If not all brokers are represented, double check that they are logged in.
|
Currently no additional flags. If not all brokers are represented, double check that they are logged in.
|
||||||
|
|||||||
@@ -21,7 +21,8 @@ In order to use 2FA you need to update [config file](/gamestonk_terminal/config_
|
|||||||
| :--- | :--- |
|
| :--- | :--- |
|
||||||
| DG_TOTP_SECRET | This secret key will let Gamestonk generate the `OneTimePassword` for you. |
|
| DG_TOTP_SECRET | This secret key will let Gamestonk generate the `OneTimePassword` for you. |
|
||||||
|
|
||||||
If you provide your `DG_TOTP_SECRET`, you won't have to type your `OneTimePassword`, Gamestonk will generate it for you at each connection.
|
If you provide your `DG_TOTP_SECRET`, you won't have to type your `OneTimePassword`, Gamestonk will generate it for you
|
||||||
|
at each connection.
|
||||||
|
|
||||||
`DG_TOTP_SECRET` is the text representation of the `QRCODE` that Degiro's provide you when you enable 2FA.
|
`DG_TOTP_SECRET` is the text representation of the `QRCODE` that Degiro's provide you when you enable 2FA.
|
||||||
|
|
||||||
@@ -55,9 +56,9 @@ More information on 2FA credentials, in the documentation of the [degiro-connect
|
|||||||
* [topnews](#topnews)
|
* [topnews](#topnews)
|
||||||
* Command to get top news preview
|
* Command to get top news preview
|
||||||
|
|
||||||
|
|
||||||
### login <a name="login"></a>
|
### login <a name="login"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: login [-u USERNAME] [-p PASSWORD] [-o OTP] [-s TOPT_SECRET] [-h]
|
usage: login [-u USERNAME] [-p PASSWORD] [-o OTP] [-s TOPT_SECRET] [-h]
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
@@ -69,28 +70,31 @@ optional arguments:
|
|||||||
-s TOPT_SECRET, --topt-secret TOPT_SECRET
|
-s TOPT_SECRET, --topt-secret TOPT_SECRET
|
||||||
TOTP SECRET (2FA).
|
TOTP SECRET (2FA).
|
||||||
-h, --help show this help message
|
-h, --help show this help message
|
||||||
````
|
```
|
||||||
|
|
||||||
### logout <a name="logout"></a>
|
### logout <a name="logout"></a>
|
||||||
````
|
|
||||||
usage: logout
|
|
||||||
````
|
|
||||||
|
|
||||||
|
```text
|
||||||
|
usage: logout
|
||||||
|
```
|
||||||
|
|
||||||
### hold <a name="hold"></a>
|
### hold <a name="hold"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: hold
|
usage: hold
|
||||||
````
|
```
|
||||||
|
|
||||||
Displays current holdings to the console.
|
Displays current holdings to the console.
|
||||||
|
|
||||||
### lookup <a name="lookup"></a>
|
### lookup <a name="lookup"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: lookup TESLA
|
usage: lookup TESLA
|
||||||
````
|
```
|
||||||
|
|
||||||
It will display a result like this :
|
It will display a result like this :
|
||||||
```
|
|
||||||
|
```text
|
||||||
name isin symbol productType currency closePrice closePriceDate
|
name isin symbol productType currency closePrice closePriceDate
|
||||||
0 Tesla US88160R1014 TSLA STOCK USD 571.690 2021-05-13
|
0 Tesla US88160R1014 TSLA STOCK USD 571.690 2021-05-13
|
||||||
1 Tesla Inc US88160R1014 TL0 STOCK EUR 478.000 2021-05-13
|
1 Tesla Inc US88160R1014 TL0 STOCK EUR 478.000 2021-05-13
|
||||||
@@ -104,47 +108,52 @@ It will display a result like this :
|
|||||||
9 Leverage Shares 1x Tesla ETP IE00BKT6ZH01 STSL ETF GBX 135.550 2021-05-13
|
9 Leverage Shares 1x Tesla ETP IE00BKT6ZH01 STSL ETF GBX 135.550 2021-05-13
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### create <a name="create"></a>
|
### create <a name="create"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: create [-a {buy,sell}] (-prod PRODUCT | -sym SYMBOL) -p PRICE (-s SIZE | -up UP_TO) [-d {gtd,gtc}] [-t {limit,market,stop-limit,stop-loss}] [-h]
|
usage: create [-a {buy,sell}] (-prod PRODUCT | -sym SYMBOL) -p PRICE (-s SIZE | -up UP_TO) [-d {gtd,gtc}] [-t {limit,market,stop-limit,stop-loss}] [-h]
|
||||||
````
|
```
|
||||||
|
|
||||||
### update <a name="update"></a>
|
### update <a name="update"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: update ORDER_ID -p PRICE
|
usage: update ORDER_ID -p PRICE
|
||||||
````
|
```
|
||||||
|
|
||||||
### cancel <a name="cancel"></a>
|
### cancel <a name="cancel"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: cancel ORDER_ID
|
usage: cancel ORDER_ID
|
||||||
````
|
```
|
||||||
|
|
||||||
### pending <a name="pending"></a>
|
### pending <a name="pending"></a>
|
||||||
````
|
|
||||||
usage: pending
|
|
||||||
````
|
|
||||||
|
|
||||||
|
```text
|
||||||
|
usage: pending
|
||||||
|
```
|
||||||
|
|
||||||
### companynews <a name="companynews"></a>
|
### companynews <a name="companynews"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: companynews NL0000235190
|
usage: companynews NL0000235190
|
||||||
````
|
```
|
||||||
|
|
||||||
You need to provide the `ISIN` number of the company.
|
You need to provide the `ISIN` number of the company.
|
||||||
You can get this `ISIN` using the `dglookup` command for instance.
|
You can get this `ISIN` using the `dglookup` command for instance.
|
||||||
|
|
||||||
### lastnews <a name="lastnews"></a>
|
### lastnews <a name="lastnews"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: lastnews [-l LIMIT] [-h]
|
usage: lastnews [-l LIMIT] [-h]
|
||||||
|
|
||||||
optional arguments:
|
optional arguments:
|
||||||
-l LIMIT, --limit LIMIT
|
-l LIMIT, --limit LIMIT
|
||||||
Number of news to display.
|
Number of news to display.
|
||||||
-h, --help show this help message
|
-h, --help show this help message
|
||||||
````
|
```
|
||||||
|
|
||||||
### topnews <a name="topnews"></a>
|
### topnews <a name="topnews"></a>
|
||||||
````
|
|
||||||
|
```text
|
||||||
usage: topnews
|
usage: topnews
|
||||||
````
|
```
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
# PORTFOLIO ANALYSIS
|
# PORTFOLIO ANALYSIS
|
||||||
|
|
||||||
This menu aims to analyze a portfolio loaded through csv/json/xlsx, and the usage of the following commands along with an example will be exploited below.
|
This menu aims to analyze a portfolio loaded through csv/json/xlsx, and the usage of the following commands along with
|
||||||
|
an example will be exploited below.
|
||||||
|
|
||||||
* [load](#load)
|
* [load](#load)
|
||||||
* load portfolio from a file
|
* load portfolio from a file
|
||||||
@@ -8,10 +9,16 @@ This menu aims to analyze a portfolio loaded through csv/json/xlsx, and the usag
|
|||||||
* view holdings by a user input group
|
* view holdings by a user input group
|
||||||
|
|
||||||
## load
|
## load
|
||||||
```
|
|
||||||
|
```text
|
||||||
usage: load [-p PATH] [--no_sector] [--no_last_price] [--nan]
|
usage: load [-p PATH] [--no_sector] [--no_last_price] [--nan]
|
||||||
```
|
```
|
||||||
This function allows you to load from a predefined file. The file can contain any information you want, but the stocks should be under a column `Ticker`. The number owned should be defined in `Shares`. By default, this will loop through all Tickers and pull sector and latest price. An example column that could be added would be if the ticker is considered a Value or Growth stock.
|
|
||||||
|
This function allows you to load from a predefined file. The file can contain any information you want, but the stocks
|
||||||
|
should be under a column `Ticker`. The number owned should be defined in `Shares`. By default, this will loop through
|
||||||
|
all Tickers and pull sector and latest price. An example column that could be added would be if the ticker is considered
|
||||||
|
a Value or Growth stock.
|
||||||
|
|
||||||
* -p/--path : Path to portfolio file. A template is supplied and the default path points to it.
|
* -p/--path : Path to portfolio file. A template is supplied and the default path points to it.
|
||||||
* --no_sector : Flag to avoid getting the sector of each stock.
|
* --no_sector : Flag to avoid getting the sector of each stock.
|
||||||
* --no_last_price : Flag to avoid getting the latest price for each supplied stock.
|
* --no_last_price : Flag to avoid getting the latest price for each supplied stock.
|
||||||
@@ -35,10 +42,13 @@ This function allows you to load from a predefined file. The file can contain a
|
|||||||
```
|
```
|
||||||
|
|
||||||
## group
|
## group
|
||||||
```
|
|
||||||
|
```text
|
||||||
usage: group [-g GROUP]
|
usage: group [-g GROUP]
|
||||||
```
|
```
|
||||||
|
|
||||||
Displays data in groups based on columns. Currently this only looks at the `value` column.
|
Displays data in groups based on columns. Currently this only looks at the `value` column.
|
||||||
|
|
||||||
* -g/--group : Column to group data by. Ex: "sector"
|
* -g/--group : Column to group data by. Ex: "sector"
|
||||||
|
|
||||||
```python
|
```python
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
# PORTFOLIO OPTIMIZATION
|
# PORTFOLIO OPTIMIZATION
|
||||||
|
|
||||||
This menu aims to optimize a portfolio of pre-loaded stocks, and the usage of the following commands along with an example will be exploited below.
|
This menu aims to optimize a portfolio of pre-loaded stocks, and the usage of the following commands along with an
|
||||||
|
example will be exploited below.
|
||||||
|
|
||||||
* [select](#select)
|
* [select](#select)
|
||||||
* select list of tickers to be optimized
|
* select list of tickers to be optimized
|
||||||
@@ -37,11 +37,11 @@ This menu aims to optimize a portfolio of pre-loaded stocks, and the usage of th
|
|||||||
* show the efficient frontier
|
* show the efficient frontier
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
* [> ca](comparison_analysis/README.md)
|
* [> ca](comparison_analysis/README.md)
|
||||||
* **comparison analysis for selected tickers**
|
* **comparison analysis for selected tickers**
|
||||||
|
|
||||||
|
## Tickers <a name="Tickers"></a>
|
||||||
|
|
||||||
|
|
||||||
### select <a name="select"></a>
|
### select <a name="select"></a>
|
||||||
|
|
||||||
@@ -50,6 +50,7 @@ select [-t SELECT_TICKERS]
|
|||||||
```
|
```
|
||||||
|
|
||||||
Add/Select tickers for portfolio to be optimized.
|
Add/Select tickers for portfolio to be optimized.
|
||||||
|
|
||||||
* -t: Tickers to be used in the portfolio to optimize.
|
* -t: Tickers to be used in the portfolio to optimize.
|
||||||
|
|
||||||
### add <a name="add"></a>
|
### add <a name="add"></a>
|
||||||
@@ -59,6 +60,7 @@ add [-t ADD_TICKERS]
|
|||||||
```
|
```
|
||||||
|
|
||||||
Add tickers to the list of the tickers to be optimized.
|
Add tickers to the list of the tickers to be optimized.
|
||||||
|
|
||||||
* -t: Tickers to be used in the portfolio to optimize
|
* -t: Tickers to be used in the portfolio to optimize
|
||||||
|
|
||||||
### rmv <a name="rmv"></a>
|
### rmv <a name="rmv"></a>
|
||||||
@@ -68,6 +70,7 @@ rmv [-t RMV_TICKERS]
|
|||||||
```
|
```
|
||||||
|
|
||||||
Remove tickers from the list of the tickers to be optimized.
|
Remove tickers from the list of the tickers to be optimized.
|
||||||
|
|
||||||
* -t: Tickers to be removed from the tickers to optimize.
|
* -t: Tickers to be removed from the tickers to optimize.
|
||||||
|
|
||||||
## Optimization <a name="Optimization"></a>
|
## Optimization <a name="Optimization"></a>
|
||||||
@@ -80,12 +83,12 @@ equal [-v VALUE] [--pie]
|
|||||||
|
|
||||||
Returns an equally weighted portfolio
|
Returns an equally weighted portfolio
|
||||||
|
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
### mktcap <a name="mktcap"></a>
|
### mktcap <a name="mktcap"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -94,12 +97,12 @@ property -p marketCap [-v VALUE] [--pie]
|
|||||||
|
|
||||||
Returns a portfolio that is weighted based on market cap info
|
Returns a portfolio that is weighted based on market cap info
|
||||||
|
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
### dividend <a name="dividend"></a>
|
### dividend <a name="dividend"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -108,11 +111,11 @@ property -p dividend [-v VALUE] [--pie]
|
|||||||
|
|
||||||
Returns a portfolio that is weighted based on dividend yield info
|
Returns a portfolio that is weighted based on dividend yield info
|
||||||
|
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
|
|
||||||
<img width="990" alt="Captura de ecrã 2021-04-16, às 22 11 41" src="https://user-images.githubusercontent.com/25267873/115084405-c5a9fb80-9f00-11eb-8feb-a5076fab9896.png">
|
<img width="990" alt="Property" src="https://user-images.githubusercontent.com/25267873/115084405-c5a9fb80-9f00-11eb-8feb-a5076fab9896.png">
|
||||||
|
|
||||||
|
|
||||||
### property <a name="property"></a>
|
### property <a name="property"></a>
|
||||||
|
|
||||||
@@ -122,13 +125,27 @@ property [-p PROPERTY] [-v VALUE] [--pie]
|
|||||||
|
|
||||||
Returns a portfolio that is weighted based on a selected property info
|
Returns a portfolio that is weighted based on a selected property info
|
||||||
|
|
||||||
* -p : Property info to weigh. Use one of: previousClose, regularMarketOpen, twoHundredDayAverage, trailingAnnualDividendYield, payoutRatio, volume24Hr, regularMarketDayHigh, navPrice, averageDailyVolume10Day, totalAssets, regularMarketPreviousClose, fiftyDayAverage, trailingAnnualDividendRate, open, toCurrency, averageVolume10days, expireDate, yield, algorithm, dividendRate, exDividendDate, beta, circulatingSupply, regularMarketDayLow, priceHint, currency, trailingPE, regularMarketVolume, lastMarket, maxSupply, openInterest, marketCap, volumeAllCurrencies, strikePrice, averageVolume, priceToSalesTrailing12Months, dayLow, ask, ytdReturn, askSize, volume, fiftyTwoWeekHigh, forwardPE, fromCurrency, fiveYearAvgDividendYield, fiftyTwoWeekLow, bid, dividendYield, bidSize, dayHigh, annualHoldingsTurnover, enterpriseToRevenue, beta3Year, profitMargins, enterpriseToEbitda, 52WeekChange, morningStarRiskRating, forwardEps, revenueQuarterlyGrowth, sharesOutstanding, fundInceptionDate, annualReportExpenseRatio, bookValue, sharesShort, sharesPercentSharesOut, fundFamily, lastFiscalYearEnd, heldPercentInstitutions, netIncomeToCommon, trailingEps, lastDividendValue, SandP52WeekChange, priceToBook, heldPercentInsiders, shortRatio, sharesShortPreviousMonthDate, floatShares, enterpriseValue, threeYearAverageReturn, lastSplitFactor, legalType, lastDividendDate, morningStarOverallRating, earningsQuarterlyGrowth, pegRatio, lastCapGain, shortPercentOfFloat, sharesShortPriorMonth, impliedSharesOutstanding, fiveYearAverageReturn, and regularMarketPrice.
|
* -p : Property info to weigh. Use one of: previousClose, regularMarketOpen, twoHundredDayAverage,
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
trailingAnnualDividendYield, payoutRatio, volume24Hr, regularMarketDayHigh, navPrice, averageDailyVolume10Day,
|
||||||
|
totalAssets, regularMarketPreviousClose, fiftyDayAverage, trailingAnnualDividendRate, open, toCurrency,
|
||||||
|
averageVolume10days, expireDate, yield, algorithm, dividendRate, exDividendDate, beta, circulatingSupply,
|
||||||
|
regularMarketDayLow, priceHint, currency, trailingPE, regularMarketVolume, lastMarket, maxSupply, openInterest,
|
||||||
|
marketCap, volumeAllCurrencies, strikePrice, averageVolume, priceToSalesTrailing12Months, dayLow, ask, ytdReturn,
|
||||||
|
askSize, volume, fiftyTwoWeekHigh, forwardPE, fromCurrency, fiveYearAvgDividendYield, fiftyTwoWeekLow, bid,
|
||||||
|
dividendYield, bidSize, dayHigh, annualHoldingsTurnover, enterpriseToRevenue, beta3Year, profitMargins,
|
||||||
|
enterpriseToEbitda, 52WeekChange, morningStarRiskRating, forwardEps, revenueQuarterlyGrowth, sharesOutstanding,
|
||||||
|
fundInceptionDate, annualReportExpenseRatio, bookValue, sharesShort, sharesPercentSharesOut, fundFamily,
|
||||||
|
lastFiscalYearEnd, heldPercentInstitutions, netIncomeToCommon, trailingEps, lastDividendValue, SandP52WeekChange,
|
||||||
|
priceToBook, heldPercentInsiders, shortRatio, sharesShortPreviousMonthDate, floatShares, enterpriseValue,
|
||||||
|
threeYearAverageReturn, lastSplitFactor, legalType, lastDividendDate, morningStarOverallRating,
|
||||||
|
earningsQuarterlyGrowth, pegRatio, lastCapGain, shortPercentOfFloat, sharesShortPriorMonth, impliedSharesOutstanding,
|
||||||
|
fiveYearAverageReturn, and regularMarketPrice.
|
||||||
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
## Mean Variance Optimization <a name="Mean_Variance_Optimization"></a>
|
## Mean Variance Optimization <a name="Mean_Variance_Optimization"></a>
|
||||||
|
|
||||||
These approaches are based off of the efficient frontier approach, which is meant to solve the following optimization problem.
|
These approaches are based off of the efficient frontier approach, which is meant to solve the following optimization problem.
|
||||||
@@ -139,88 +156,93 @@ These approaches are based off of the efficient frontier approach, which is mean
|
|||||||
|
|
||||||
* Where S is the covariance matrix between stocks and R is the expected returns.
|
* Where S is the covariance matrix between stocks and R is the expected returns.
|
||||||
* The condition that all weights add up to 1 just implies that you want to have a net long portfolio (with no margin).
|
* The condition that all weights add up to 1 just implies that you want to have a net long portfolio (with no margin).
|
||||||
* A long-short portfolio can have negative weights and usually wants to have everything add up to 0 for a market-neutral strategy.
|
* A long-short portfolio can have negative weights and usually wants to have everything add up to 0 for a market-neutral
|
||||||
|
strategy.
|
||||||
|
|
||||||
Currently, we do not allow for changing risk models or adding constraints.
|
Currently, we do not allow for changing risk models or adding constraints.
|
||||||
If there is something specific, please submit a feature request, or if you can write it, feel free to add a PR!
|
If there is something specific, please submit a feature request, or if you can write it, feel free to add a PR!
|
||||||
All of these commands use [PyPortFolioOpt](#https://pyportfolioopt.readthedocs.io/en/latest/index.html) package.
|
All of these commands use [PyPortFolioOpt](#https://pyportfolioopt.readthedocs.io/en/latest/index.html) package.
|
||||||
|
|
||||||
|
|
||||||
### maxsharpe <a name="maxhsarpe"></a>
|
### maxsharpe <a name="maxhsarpe"></a>
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: max_sharpe [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-r RISK_FREE_RATE]
|
usage: max_sharpe [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-r RISK_FREE_RATE]
|
||||||
````
|
```
|
||||||
|
|
||||||
Maximise the Sharpe Ratio. The result is also referred to as the tangency portfolio, as it is the portfolio for which the capital market line is tangent to the efficient frontier. This is a convex optimization problem after making a certain variable substitution. See Cornuejols and Tutuncu (2006) <http://web.math.ku.dk/~rolf/CT_FinOpt.pdf> for more. The sharpe ratio is defined as (Mean Returns - Risk Free Rate)/(Standard Deviation of Returns).
|
Maximise the Sharpe Ratio. The result is also referred to as the tangency portfolio, as it is the portfolio for which
|
||||||
|
the capital market line is tangent to the efficient frontier. This is a convex optimization problem after making a
|
||||||
|
certain variable substitution. See Cornuejols and Tutuncu (2006) <http://web.math.ku.dk/~rolf/CT_FinOpt.pdf> for more.
|
||||||
|
The sharpe ratio is defined as (Mean Returns - Risk Free Rate)/(Standard Deviation of Returns).
|
||||||
|
|
||||||
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
|
|
||||||
<img width="997" alt="maxsharpe" src="https://user-images.githubusercontent.com/25267873/114958291-9771e080-9e5a-11eb-824d-f9d1e5b22444.png">
|
<img width="997" alt="maxsharpe" src="https://user-images.githubusercontent.com/25267873/114958291-9771e080-9e5a-11eb-824d-f9d1e5b22444.png">
|
||||||
|
|
||||||
|
|
||||||
### minvol <a name="minvol"></a>
|
### minvol <a name="minvol"></a>
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: minvol [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie]
|
usage: minvol [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie]
|
||||||
````
|
```
|
||||||
|
|
||||||
This portfolio minimizes the total volatility, which also means it has the smallest returns among the efficient frontier.
|
This portfolio minimizes the total volatility, which also means it has the smallest returns among the efficient frontier.
|
||||||
|
|
||||||
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
|
|
||||||

|

|
||||||
<img width="995" alt="min_vol2" src="https://user-images.githubusercontent.com/25267873/114958289-96d94a00-9e5a-11eb-8c50-c4f834f0d8e1.png">
|
<img width="995" alt="min_vol2" src="https://user-images.githubusercontent.com/25267873/114958289-96d94a00-9e5a-11eb-8c50-c4f834f0d8e1.png">
|
||||||
|
|
||||||
|
|
||||||
### maxquadutil <a name="maxquadutil"></a>
|
### maxquadutil <a name="maxquadutil"></a>
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: maxquadutil [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-r RISK_AVERSION] [-n]
|
usage: maxquadutil [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-r RISK_AVERSION] [-n]
|
||||||
````
|
```
|
||||||
|
|
||||||
Maximises the quadratic utility, given some risk aversion.
|
Maximises the quadratic utility, given some risk aversion.
|
||||||
|
|
||||||
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
* -r : Risk aversion parameter
|
* -r : Risk aversion parameter
|
||||||
* -n : Whether the portfolio should be market neutral (weights sum to zero). Defaults: False.
|
* -n : Whether the portfolio should be market neutral (weights sum to zero). Defaults: False.
|
||||||
|
|
||||||
<img width="1004" alt="maxquadutil" src="https://user-images.githubusercontent.com/25267873/114958288-9640b380-9e5a-11eb-8b4e-ac61b11db638.png">
|
<img width="1004" alt="maxquadutil" src="https://user-images.githubusercontent.com/25267873/114958288-9640b380-9e5a-11eb-8b4e-ac61b11db638.png">
|
||||||
|
|
||||||
|
|
||||||
### effret <a name="effret"></a>
|
### effret <a name="effret"></a>
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: effret [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-t TARGET_RETURN] [-n]
|
usage: effret [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-t TARGET_RETURN] [-n]
|
||||||
````
|
```
|
||||||
|
|
||||||
Calculate the 'Markowitz portfolio', minimising volatility for a given target return.
|
Calculate the 'Markowitz portfolio', minimising volatility for a given target return.
|
||||||
|
|
||||||
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
* -t : The desired return of the resulting portfolio
|
* -t : The desired return of the resulting portfolio
|
||||||
* -n : Whether the portfolio should be market neutral (weights sum to zero). Defaults: False.
|
* -n : Whether the portfolio should be market neutral (weights sum to zero). Defaults: False.
|
||||||
|
|
||||||
<img width="990" alt="effret" src="https://user-images.githubusercontent.com/25267873/114958286-9640b380-9e5a-11eb-986a-0ddf359121ae.png">
|
<img width="990" alt="effret" src="https://user-images.githubusercontent.com/25267873/114958286-9640b380-9e5a-11eb-986a-0ddf359121ae.png">
|
||||||
|
|
||||||
|
|
||||||
### effrisk <a name="effrisk"></a>
|
### effrisk <a name="effrisk"></a>
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: effrisk [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-t TARGET_VOLATILITY] [-n]
|
usage: effrisk [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-v VALUE] [--pie] [-t TARGET_VOLATILITY] [-n]
|
||||||
````
|
```
|
||||||
|
|
||||||
Maximise return for a target risk. The resulting portfolio will have a volatility less than the target (but not guaranteed to be equal).
|
Maximise return for a target risk. The resulting portfolio will have a volatility less than the target (but not
|
||||||
|
guaranteed to be equal).
|
||||||
|
|
||||||
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
* -p : Amount of time to retrieve data from yfinance. Default: 3mo.
|
||||||
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns the weights.
|
* -v : If provided, this represents an actual allocation amount for the portfolio. Defaults to 1, which just returns
|
||||||
|
the weights.
|
||||||
* --pie : Display a pie chart for weights
|
* --pie : Display a pie chart for weights
|
||||||
* -t : The desired maximum volatility of the resulting portfolio
|
* -t : The desired maximum volatility of the resulting portfolio
|
||||||
* -n : Whether the portfolio should be market neutral (weights sum to zero). Defaults: False.
|
* -n : Whether the portfolio should be market neutral (weights sum to zero). Defaults: False.
|
||||||
@@ -228,16 +250,16 @@ Maximise return for a target risk. The resulting portfolio will have a volatilit
|
|||||||

|

|
||||||
<img width="1002" alt="effrisk2" src="https://user-images.githubusercontent.com/25267873/114958277-92ad2c80-9e5a-11eb-9e7e-ba60a4ec698e.png">
|
<img width="1002" alt="effrisk2" src="https://user-images.githubusercontent.com/25267873/114958277-92ad2c80-9e5a-11eb-9e7e-ba60a4ec698e.png">
|
||||||
|
|
||||||
|
|
||||||
### ef
|
### ef
|
||||||
|
|
||||||
````
|
```text
|
||||||
usage: ef [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-n N_PORT]
|
usage: ef [-p {1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max}] [-n N_PORT]
|
||||||
````
|
```
|
||||||
|
|
||||||
This function plots random portfolios based on their risk and returns and shows the efficient frontier.
|
This function plots random portfolios based on their risk and returns and shows the efficient frontier.
|
||||||
|
|
||||||
* -n : Number of portfolios to simulate. Default 300.
|
* -n : Number of portfolios to simulate. Default 300.
|
||||||
* -p : Amount of time to retrieve data from yfinance. Options are: 1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max and it defaults to 3mo.
|
* -p : Amount of time to retrieve data from yfinance. Options are: 1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max and it
|
||||||
|
defaults to 3mo.
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
41
gamestonk_terminal/reports/README.md
vendored
41
gamestonk_terminal/reports/README.md
vendored
@@ -1,58 +1,65 @@
|
|||||||
# REPORTS
|
# REPORTS
|
||||||
|
|
||||||
This menu has a different concept from remaining menus. It has 2 main goals:
|
This menu has a different concept from remaining menus. It has 2 main goals:
|
||||||
|
|
||||||
- Generate a personalised report.
|
- Generate a personalised report.
|
||||||
- Allow the user to write notes on that notebook (report), as if it was his personal investment diary.
|
- Allow the user to write notes on that notebook (report), as if it was his personal investment diary.
|
||||||
|
|
||||||
|
|
||||||
## How to create your own personal report
|
## How to create your own personal report
|
||||||
|
|
||||||
1. Copy one of the existing notebook reports as a template, e.g. [dark_pool.ipynb](/gamestonk_terminal/reports/dark_pool.ipynb).
|
1. Copy one of the existing notebook reports as a template, e.g. [dark_pool.ipynb](/gamestonk_terminal/reports/dark_pool.ipynb).
|
||||||
|
|
||||||
2. Rename that notebook with a name that reflects what you want this notebook to contain, even including your name.
|
2. Rename that notebook with a name that reflects what you want this notebook to contain, even including your name.
|
||||||
|
|
||||||
3. One of the notebook cells will have a `parameters` tag, that's where the papermill will parametrize the notebook. Thus, your variables should be declared there.
|
3. One of the notebook cells will have a `parameters` tag, that's where the papermill will parametrize the notebook.
|
||||||
|
Thus, your variables should be declared there.
|
||||||
|
|
||||||
4. Remove the function calls that you don't care about to build your own report.
|
4. Remove the function calls that you don't care about to build your own report.
|
||||||
|
|
||||||
5. When building your template notebook, there are 2 type of possible things you can do:
|
5. When building your template notebook, there are 2 type of possible things you can do:
|
||||||
* Create a markdown cell, where you can add a title or a description. E.g.
|
- Create a markdown cell, where you can add a title or a description. E.g.
|
||||||
```
|
|
||||||
|
```text
|
||||||
## Analyst Targets
|
## Analyst Targets
|
||||||
```
|
```
|
||||||
* Create a code cell, where you should both: import a module, and call a function to display a chart or print data. E.g.
|
|
||||||
|
- Create a code cell, where you should both: import a module, and call a function to display a chart or print data. E.g.
|
||||||
|
|
||||||
```python
|
```python
|
||||||
from gamestonk_terminal.stocks.due_diligence import finviz_view
|
from gamestonk_terminal.stocks.due_diligence import finviz_view
|
||||||
|
|
||||||
finviz_view.analyst(ticker=ticker, export='')
|
finviz_view.analyst(ticker=ticker, export='')
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note**: In order to find the name of the function you want, you should either crawl through the codebase (and ask help in discord) or look into our readthedocs (#TODO).
|
**Note**: In order to find the name of the function you want, you should either crawl through the codebase (and ask
|
||||||
|
help in discord) or look into our readthedocs (#TODO).
|
||||||
|
|
||||||
## How to run the report
|
## How to run the report
|
||||||
|
|
||||||
1. In [config_terminal](/gamestonk_terminal/config_terminal.py) you may need to change your `PAPERMILL_NOTEBOOK_REPORT_PORT` from `8888`. If the notebook generation fails, it is likely that the port selected is not the correct one.
|
1. In [config_terminal](/gamestonk_terminal/config_terminal.py) you may need to change your `PAPERMILL_NOTEBOOK_REPORT_PORT`
|
||||||
|
from `8888`. If the notebook generation fails, it is likely that the port selected is not the correct one.
|
||||||
|
|
||||||
2. Start the terminal with `python terminal.py`
|
2. Start the terminal with `python terminal.py`
|
||||||
|
|
||||||
3. Select `reports` context, and choose from the options selected - which are derived from the .ipynb jupyter notebook files on the [reports](/gamestonk_terminal/reports/) folder.
|
3. Select `reports` context, and choose from the options selected - which are derived from the .ipynb jupyter notebook
|
||||||
|
files on the [reports](/gamestonk_terminal/reports/) folder.
|
||||||
|
|
||||||
4. This should prompt you with a filled notebok with name: `<date time>_<report name>_<args>.ipynb`. E.g. `20210725_193517_dark_pool_AMC.ipynb`
|
4. This should prompt you with a filled notebook with name: `<date time>_<report name>_<args>.ipynb`. E.g. `20210725_193517_dark_pool_AMC.ipynb`
|
||||||
|
|
||||||
5. Due to the last cell of the notebook, the report is saved by default as `.html`. E.g. `20210725_193517_dark_pool_AMC.html`
|
5. Due to the last cell of the notebook, the report is saved by default as `.html`. E.g. `20210725_193517_dark_pool_AMC.html`
|
||||||
```
|
|
||||||
|
```text
|
||||||
folder = "notebooks/reports/"
|
folder = "notebooks/reports/"
|
||||||
extension = ".ipynb"
|
extension = ".ipynb"
|
||||||
!jupyter nbconvert {report_name} --to html --no-input
|
!jupyter nbconvert {report_name} --to html --no-input
|
||||||
```
|
```
|
||||||
|
|
||||||
6. You can now write your own personal notes on the notebook. By doing:
|
6. You can now write your own personal notes on the notebook. By doing:
|
||||||
* Click on the notebook cell that you are interested in writing your notes
|
- Click on the notebook cell that you are interested in writing your notes
|
||||||
* On the toolbar click on "+" to add a new cell
|
- On the toolbar click on "+" to add a new cell
|
||||||
* On the tooblar click on "Cell" -> "Cell Type" -> "Markdown"
|
- On the toolbar click on "Cell" -> "Cell Type" -> "Markdown"
|
||||||
* You're now ready to write your own notes
|
- You're now ready to write your own notes
|
||||||
|
|
||||||
7. Once you're happy with your report, you can either:
|
7. Once you're happy with your report, you can either:
|
||||||
* Re-run the last cell, potentially changing output from `.html`:
|
- Re-run the last cell, potentially changing output from `.html`:
|
||||||
* Or, on the toolbar click on "File" -> "Download as" -> Select your preferred option (e.g. HTML)
|
- Or, on the toolbar click on "File" -> "Download as" -> Select your preferred option (e.g. HTML)
|
||||||
|
|||||||
9
gamestonk_terminal/resources/README.md
vendored
9
gamestonk_terminal/resources/README.md
vendored
@@ -1,6 +1,7 @@
|
|||||||
# RESOURCE COLLECTION
|
# RESOURCE COLLECTION
|
||||||
|
|
||||||
This menu aims to store a collection of useful resources that can't be scraped, or extracted in a "useful" manner, and the usage of the following commands along with an example will be exploited below.
|
This menu aims to store a collection of useful resources that can't be scraped, or extracted in a "useful" manner, and
|
||||||
|
the usage of the following commands along with an example will be exploited below.
|
||||||
|
|
||||||
* [hfletters](#hfletters)
|
* [hfletters](#hfletters)
|
||||||
* hedge fund letters or reports
|
* hedge fund letters or reports
|
||||||
@@ -15,7 +16,6 @@ This menu aims to store a collection of useful resources that can't be scraped,
|
|||||||
* [learn](#learn)
|
* [learn](#learn)
|
||||||
* trading analysis, tips and resources
|
* trading analysis, tips and resources
|
||||||
|
|
||||||
|
|
||||||
## hfletters <a name="hfletters"></a>
|
## hfletters <a name="hfletters"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -25,7 +25,6 @@ usage: hfletters
|
|||||||
<img width="1144" alt="Captura de ecrã 2021-05-01, às 21 13 22" src="https://user-images.githubusercontent.com/25267873/116794054-400e7a00-aac2-11eb-92ba-b14d979ef6c1.png">
|
<img width="1144" alt="Captura de ecrã 2021-05-01, às 21 13 22" src="https://user-images.githubusercontent.com/25267873/116794054-400e7a00-aac2-11eb-92ba-b14d979ef6c1.png">
|
||||||
<img width="1227" alt="Captura de ecrã 2021-05-01, às 21 14 08" src="https://user-images.githubusercontent.com/25267873/116794053-3edd4d00-aac2-11eb-8abf-5a3a32ae3484.png">
|
<img width="1227" alt="Captura de ecrã 2021-05-01, às 21 14 08" src="https://user-images.githubusercontent.com/25267873/116794053-3edd4d00-aac2-11eb-8abf-5a3a32ae3484.png">
|
||||||
|
|
||||||
|
|
||||||
## arxiv <a name="arxiv"></a>
|
## arxiv <a name="arxiv"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -34,7 +33,6 @@ usage: arxiv
|
|||||||
|
|
||||||
<img width="1279" alt="arxiv" src="https://user-images.githubusercontent.com/25267873/117510134-6f6e2c80-af83-11eb-9458-a7a160bb57f0.png">
|
<img width="1279" alt="arxiv" src="https://user-images.githubusercontent.com/25267873/117510134-6f6e2c80-af83-11eb-9458-a7a160bb57f0.png">
|
||||||
|
|
||||||
|
|
||||||
## finra <a name="finra"></a>
|
## finra <a name="finra"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -43,7 +41,6 @@ usage: finra
|
|||||||
|
|
||||||
<img width="1278" alt="finra" src="https://user-images.githubusercontent.com/25267873/117510141-7137f000-af83-11eb-8b07-65176791bf72.png">
|
<img width="1278" alt="finra" src="https://user-images.githubusercontent.com/25267873/117510141-7137f000-af83-11eb-8b07-65176791bf72.png">
|
||||||
|
|
||||||
|
|
||||||
## edgar <a name="edgar"></a>
|
## edgar <a name="edgar"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -52,7 +49,6 @@ usage: edgar
|
|||||||
|
|
||||||
<img width="1278" alt="edgar" src="https://user-images.githubusercontent.com/25267873/117510138-709f5980-af83-11eb-8968-919e4235d480.png">
|
<img width="1278" alt="edgar" src="https://user-images.githubusercontent.com/25267873/117510138-709f5980-af83-11eb-8968-919e4235d480.png">
|
||||||
|
|
||||||
|
|
||||||
## fred <a name="fred"></a>
|
## fred <a name="fred"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
@@ -61,7 +57,6 @@ usage: fred
|
|||||||
|
|
||||||
<img width="1279" alt="fred" src="https://user-images.githubusercontent.com/25267873/117510128-6c733c00-af83-11eb-9dfe-8a86412aeefb.png">
|
<img width="1279" alt="fred" src="https://user-images.githubusercontent.com/25267873/117510128-6c733c00-af83-11eb-9dfe-8a86412aeefb.png">
|
||||||
|
|
||||||
|
|
||||||
## learn <a name="learn"></a>
|
## learn <a name="learn"></a>
|
||||||
|
|
||||||
```text
|
```text
|
||||||
|
|||||||
@@ -24,4 +24,3 @@ Command|Description|Source
|
|||||||
`metrics` |core social sentiment metrics for this stock|[Sentiment Investor](https://sentimentinvestor.com)
|
`metrics` |core social sentiment metrics for this stock|[Sentiment Investor](https://sentimentinvestor.com)
|
||||||
`social` |social media figures for stock popularity|[Sentiment Investor](https://sentimentinvestor.com)
|
`social` |social media figures for stock popularity|[Sentiment Investor](https://sentimentinvestor.com)
|
||||||
`historical` |plot the past week of data for a selected metric|[Sentiment Investor](https://sentimentinvestor.com)
|
`historical` |plot the past week of data for a selected metric|[Sentiment Investor](https://sentimentinvestor.com)
|
||||||
|
|
||||||
|
|||||||
@@ -2,4 +2,4 @@
|
|||||||
|
|
||||||
Check all features [HERE](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/dark_pool_shorts).
|
Check all features [HERE](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/dark_pool_shorts).
|
||||||
|
|
||||||
#TODO
|
**TODO**
|
||||||
|
|||||||
@@ -2,4 +2,4 @@
|
|||||||
|
|
||||||
Check all features [HERE](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/fundamental_analysis/fmp).
|
Check all features [HERE](https://gamestonkterminal.github.io/GamestonkTerminal/stocks/fundamental_analysis/fmp).
|
||||||
|
|
||||||
#TODO
|
**TODO**
|
||||||
|
|||||||
@@ -35,7 +35,8 @@
|
|||||||
|
|
||||||
<img width="859" alt="3" src="https://user-images.githubusercontent.com/25267873/123713235-da453100-d86b-11eb-9f65-f957f99d5d60.png">
|
<img width="859" alt="3" src="https://user-images.githubusercontent.com/25267873/123713235-da453100-d86b-11eb-9f65-f957f99d5d60.png">
|
||||||
|
|
||||||
6. It may be useful to play with the main source https://finviz.com/screener.ashx since you can tweak these and understand how they influence the outcome of the filtered stocks.
|
6. It may be useful to play with the main source <https://finviz.com/screener.ashx> since you can tweak these and
|
||||||
|
understand how they influence the outcome of the filtered stocks.
|
||||||
|
|
||||||
<img width="1256" alt="4" src="https://user-images.githubusercontent.com/25267873/123713236-daddc780-d86b-11eb-9faf-2ee58fc304d3.png">
|
<img width="1256" alt="4" src="https://user-images.githubusercontent.com/25267873/123713236-daddc780-d86b-11eb-9faf-2ee58fc304d3.png">
|
||||||
|
|
||||||
@@ -44,28 +45,35 @@
|
|||||||
<img width="807" alt="5" src="https://user-images.githubusercontent.com/25267873/123713239-db765e00-d86b-11eb-8b58-127205d75894.png">
|
<img width="807" alt="5" src="https://user-images.githubusercontent.com/25267873/123713239-db765e00-d86b-11eb-8b58-127205d75894.png">
|
||||||
|
|
||||||
8. Start the terminal, and go to the `> scr` menu. In there, you can play with it on the terminal as shown:
|
8. Start the terminal, and go to the `> scr` menu. In there, you can play with it on the terminal as shown:
|
||||||
|
|
||||||
* **view**: Allows to see the screeners available. I.e. all `.ini` files in presets folder.
|
* **view**: Allows to see the screeners available. I.e. all `.ini` files in presets folder.
|
||||||
<img width="1201" alt="6" src="https://user-images.githubusercontent.com/25267873/123713231-d9ac9a80-d86b-11eb-920a-0959481de143.png">
|
<img width="1201" alt="6" src="https://user-images.githubusercontent.com/25267873/123713231-d9ac9a80-d86b-11eb-920a-0959481de143.png">
|
||||||
|
|
||||||
* **view <selected_preset>**: Allows to see the specific parameters set for the preset selected.
|
* **view <selected_preset>**: Allows to see the specific parameters set for the preset selected.
|
||||||
<img width="443" alt="Captura de ecrã 2021-06-28, às 23 58 35" src="https://user-images.githubusercontent.com/25267873/123713683-d82fa200-d86c-11eb-92ee-bf5ae14d5f12.png">
|
<img width="443" alt="Captura de ecrã 2021-06-28, às 23 58 35" src="https://user-images.githubusercontent.com/25267873/123713683-d82fa200-d86c-11eb-92ee-bf5ae14d5f12.png">
|
||||||
|
|
||||||
* **set <selected_preset>**: Allows to set this preset as main filter. See that the help menu will display a different `PRESET: my_own_filter`
|
* **set <selected_preset>**: Allows to set this preset as main filter. See that the help menu will display a different
|
||||||
|
`PRESET: my_own_filter`
|
||||||
<img width="857" alt="7" src="https://user-images.githubusercontent.com/25267873/123713226-d9140400-d86b-11eb-9a61-bce07b6f580d.png">
|
<img width="857" alt="7" src="https://user-images.githubusercontent.com/25267873/123713226-d9140400-d86b-11eb-9a61-bce07b6f580d.png">
|
||||||
|
|
||||||
* **historical, overview, valuation, financial, ownership, performance, technical** commands will now be performed on tickers that are filtered with the selected preset. Note: Since it is likely that there will be a big range of tickers, we cap it to 10 randomly. So, it is normal if for the same filter the user sees 10 different tickers. If the user wants to see more than 10 tickers, it can select a different limit using `-l` flag.
|
* **historical, overview, valuation, financial, ownership, performance, technical** commands will now be performed on
|
||||||
|
tickers that are filtered with the selected preset. Note: Since it is likely that there will be a big range of
|
||||||
|
tickers, we cap it to 10 randomly. So, it is normal if for the same filter the user sees 10 different tickers.
|
||||||
|
If the user wants to see more than 10 tickers, it can select a different limit using `-l` flag.
|
||||||
|
|
||||||
<img width="1049" alt="8" src="https://user-images.githubusercontent.com/25267873/123713223-d6191380-d86b-11eb-9e50-ac3a32d7922d.png">
|
<img width="1049" alt="8" src="https://user-images.githubusercontent.com/25267873/123713223-d6191380-d86b-11eb-9e50-ac3a32d7922d.png">
|
||||||
|
|
||||||
9. Share with other Apes. You can do so by either creating yourself a Pull Request with this change, or asking a dev (e.g. @Sexy_Year) on our discord server to add it for you.
|
9. Share with other Apes. You can do so by either creating yourself a Pull Request with this change, or asking a dev
|
||||||
|
(e.g. @Sexy_Year) on our discord server to add it for you.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## template
|
## template
|
||||||
|
|
||||||
* **Author of preset:** GamestonkTerminal
|
* **Author of preset:** GamestonkTerminal
|
||||||
* **Contact:** https://github.com/DidierRLopes/GamestonkTerminal#contacts
|
* **Contact:** <https://github.com/DidierRLopes/GamestonkTerminal#contacts>
|
||||||
* **Description:** Template with all available filters and their options menu. More information can be found in https://finviz.com/help/screener.ashx and https://finviz.com/help/technical-analysis/charts-patterns.ashx
|
* **Description:** Template with all available filters and their options menu. More information can be found in
|
||||||
|
<https://finviz.com/help/screener.ashx> and <https://finviz.com/help/technical-analysis/charts-patterns.ashx>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -73,7 +81,8 @@
|
|||||||
|
|
||||||
* **Author of preset:** Sexy Year
|
* **Author of preset:** Sexy Year
|
||||||
* **Contact:** Add contact of author, if (s)he whishes to be contacted. This can be an hyperlink, an e-mail, wtv
|
* **Contact:** Add contact of author, if (s)he whishes to be contacted. This can be an hyperlink, an e-mail, wtv
|
||||||
* **Description:** This is just a sample. The user that adds the preset can add a description for what type of stocks these filters are aimed for
|
* **Description:** This is just a sample. The user that adds the preset can add a description for what type of stocks
|
||||||
|
these filters are aimed for
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -114,7 +123,7 @@
|
|||||||
* **Author of preset:** Traceabl3
|
* **Author of preset:** Traceabl3
|
||||||
* **Contact:** take the red pill
|
* **Contact:** take the red pill
|
||||||
* **Description:** Death cross : when the 50sma crosses below the 200 sma
|
* **Description:** Death cross : when the 50sma crosses below the 200 sma
|
||||||
* **More information:** https://www.investopedia.com/terms/d/deathcross.asp
|
* **More information:** <https://www.investopedia.com/terms/d/deathcross.asp>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -135,6 +144,7 @@
|
|||||||
---
|
---
|
||||||
|
|
||||||
## modified_dreman
|
## modified_dreman
|
||||||
|
|
||||||
* **Author of preset:** Traceabl3
|
* **Author of preset:** Traceabl3
|
||||||
* **Contact:** Drum Telegraphy
|
* **Contact:** Drum Telegraphy
|
||||||
* **Description:** Modified Version of the Dreman Screener.
|
* **Description:** Modified Version of the Dreman Screener.
|
||||||
@@ -146,7 +156,7 @@
|
|||||||
* **Author of preset:** Traceabl3
|
* **Author of preset:** Traceabl3
|
||||||
* **Contact:** bang the drums
|
* **Contact:** bang the drums
|
||||||
* **Description:** Neff Screener with modifications // operational margin <50%
|
* **Description:** Neff Screener with modifications // operational margin <50%
|
||||||
* **More information:** https://marketxls.com/template/neff-screen/
|
* **More information:** <https://marketxls.com/template/neff-screen/>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user