Merge branch 'develop' into feature/real_estate

This commit is contained in:
James Maslek
2023-01-30 13:24:57 -05:00
committed by GitHub
159 changed files with 669 additions and 1631 deletions

View File

@@ -151,8 +151,6 @@ def parse_and_split_input(an_input: str, custom_filters: List) -> List[str]:
if an_input:
if an_input == "/":
an_input = "home"
elif an_input[0] == "/":
an_input = "home" + an_input
# everything from ` -f ` to the next known extension
file_flag = r"(\ -f |\ --file )"

View File

@@ -1,19 +1,20 @@
en:
_home_: Information, guides and support for the OpenBB Terminal
intro: introduction on the OpenBB Terminal
about: discover the capabilities of the OpenBB Terminal (https://openbb.co/docs)
support: pre-populate a support ticket for our team to evaluate
survey: fill in our 2-minute survey so we better understand how we can improve the terminal
update: attempt to update the terminal automatically (GitHub version)
exe: execute automated routine script
wiki: search for an expression in Wikipedia (https://www.wikipedia.org/)
news: display news articles based on term and data sources
settings: tune settings (export folder, timezone, language, plot size)
keys: set API keys and check their validity
featflags: enable and disable feature flags
sources: select your preferred data sources
keys: set API keys and check their validity
wiki: search for an expression in Wikipedia (https://www.wikipedia.org/)
record: record session to be converted into a .openbb routine
stop: stop session recording
intro: introduction on the OpenBB Terminal
settings: tune settings (export folder, timezone, language, plot size)
_scripts_: Record and execute your own .openbb routine scripts
record: start recording current session
stop: stop session recording and convert to .openbb routine
exe: execute .openbb routine scripts (use exe --example for an example)
_configure_: Configure your own terminal
_main_menu_: Main menu
keys/_keys_: This menu allows you to set your own API keys. Type 'about' for more information
@@ -916,7 +917,7 @@ en:
econometrics/coint: co-integration test on a multitude of columns
portfolio/bro: brokers holdings, supports robinhood, ally, degiro, coinbase
portfolio/po: portfolio optimization, optimize your portfolio weights efficiently
portfolio/load: load transactions into the portfolio
portfolio/load: load transactions into the portfolio (use load --example for an example)
portfolio/_loaded: Loaded transactions
portfolio/_riskfreerate: Risk Free Rate
portfolio/show: show existing transactions
@@ -975,7 +976,7 @@ en:
portfolio/bro/cb/deposits: show all your deposits or internal transfers
portfolio/bro/cb/orders: show all your orders
portfolio/po/file: file that contains portfolio risk parameters
portfolio/po/load: load tickers and categories from .xlsx or .csv file
portfolio/po/load: load tickers and categories from .xlsx or .csv file (use load --example for an example)
portfolio/po/_loaded: Portfolio loaded
portfolio/po/_tickers: Tickers
portfolio/po/_categories: Categories

View File

@@ -9,7 +9,7 @@ plot
plot -pf a,b
plot -ct a,b
plot -pf a,b -ct c,d
load --file 50_30_10_10_Portfolio.xlsx
load --example
show -pf a,b -ct c,d
show -pf a
show -ct c
@@ -39,7 +39,7 @@ plot -pf name_0,maxsharpe_1 -ct c,sector,current_invested_amount -dd
plot -pf name_0,maxsharpe_1 -ct c,sector,current_invested_amount -rc
plot -pf name_0,maxsharpe_1 -ct c,sector,current_invested_amount -he
..
load --file market.csv
load --example
po
equal
show -pf name_0

View File

@@ -1,5 +1,5 @@
portfolio
load -f Public_Equity_Orderbook.xlsx
load --example
show
bench QQQ
alloc assets -t -l 4

View File

@@ -1,8 +1,8 @@
portfolio
load --file Public_Equity_Orderbook.xlsx
load --example
po
params
load OpenBB_Parameters_Template_v1.0.0.xlsx
load
set ef
arg tangency False
arg log_returns True

View File

@@ -1,7 +1,7 @@
portfolio
po
load 60_40_Portfolio.xlsx
file --file example.ini
load --example
file
maxsharpe -s 2022-10-20
minrisk -r 0.05
maxutil -a 0.1 -ra 2 -tk 0.4 -tr 8
@@ -23,7 +23,7 @@ plot -pf MAXSHARPE_0 -rc
plot -pf MAXSHARPE_0 -he
rpf NAME_6
..
load --file market.csv
load --example
po
equal
maxsharpe -s 1995-05-07

View File

@@ -1,8 +1,8 @@
reports
portfolio Public_Equity_Orderbook.xlsx
portfolio --transactions holdings_example.xlsx
# Test with invalid path
portfolio Public_Equity_Orderbook_test.xlsx
portfolio --transactions holdings_test.xlsx
exit

View File

@@ -1,3 +0,0 @@
Date,Ticker,Type,Sector,Industry,Country,Price,Quantity,Fees,Premium,Investment,Side,Currency
7/20/2021,btc,CRYPTO,Digital Currency,Large,United States,29790,1,0,0,29790,Buy,USD
7/25/2021,eth,CRYPTO,Digital Asset,Mid,United States,29799,1,0,0,29799,Buy,USD
1 Date Ticker Type Sector Industry Country Price Quantity Fees Premium Investment Side Currency
2 7/20/2021 btc CRYPTO Digital Currency Large United States 29790 1 0 0 29790 Buy USD
3 7/25/2021 eth CRYPTO Digital Asset Mid United States 29799 1 0 0 29799 Buy USD

View File

@@ -1,5 +0,0 @@
Date,Ticker,Type,Sector,Industry,Country,Price,Quantity,Fees,Premium,Investment,Side,Currency
3/24/2021,aapl,stock,Technology,Communication Services,United States,120.7,300,0,0,0,Buy,USD
3/26/2021,msft,stock,Technology,Communication Services,United States,232.8,200,0,0,0,Buy,USD
5/21/2021,btc,crypto,Digital Assets,Digital Assets,United States,37430,1,0,0,0,Buy,USD
7/2/2021,aapl,stock,Technology,Communication Services,United States,139.8,300,0,0,0,Buy,USD
1 Date Ticker Type Sector Industry Country Price Quantity Fees Premium Investment Side Currency
2 3/24/2021 aapl stock Technology Communication Services United States 120.7 300 0 0 0 Buy USD
3 3/26/2021 msft stock Technology Communication Services United States 232.8 200 0 0 0 Buy USD
4 5/21/2021 btc crypto Digital Assets Digital Assets United States 37430 1 0 0 0 Buy USD
5 7/2/2021 aapl stock Technology Communication Services United States 139.8 300 0 0 0 Buy USD

View File

@@ -1,3 +0,0 @@
Date,Ticker,Type,Sector,Industry,Country,Price,Quantity,Fees,Premium,Investment,Side,Currency
10/12/2018,QQQ,ETF,American Technology,Large,United States,174.32,30,0,0,0,Buy,USD
6/5/2020,SPY,ETF,American Market,Large,United States,319.34,10,0,0,0,Buy,USD
1 Date Ticker Type Sector Industry Country Price Quantity Fees Premium Investment Side Currency
2 10/12/2018 QQQ ETF American Technology Large United States 174.32 30 0 0 0 Buy USD
3 6/5/2020 SPY ETF American Market Large United States 319.34 10 0 0 0 Buy USD

View File

@@ -1,7 +0,0 @@
[OPENBB]
freq = d
maxnan = 0.1923912931924
method = time
risk_measure = MV
alpha = 3

View File

@@ -1,6 +0,0 @@
[OPENBB]
freq = d
maxnan = 0.05
method = time
risk_measure = MV

View File

@@ -1,8 +0,0 @@
[OPENBB]
historic_period=3y
log_returns=0
return_frequency=d
max_nan=0.05
threshold_value=0.3
nan_fill_method=time
significance_level=0.05

View File

@@ -1,7 +0,0 @@
[OPENBB]
interval=3y
log_returns=0
freq=d
maxnan=0.05
threshold=0.3
alpha=0.05

View File

@@ -1,7 +0,0 @@
[OPENBB]
freq = d
maxnan = 1.69
method = time
risk_measure = MV
alpha = 3

View File

@@ -1,15 +0,0 @@
# ROUTINES
This folder introduces the concept of routines, which are meant for the user to develop and run at once. The notebook reports is a better approach to this idea, but currently the development of this is not trivial. On the other hand, the development of this is trivial as long as the user is familiar with our terminal interface.
Try out with:
```bash
python terminal.py routines/example.openbb
```
Or within the Terminal, use:
```bash
exe routines/example.openbb
```

View File

@@ -1,29 +0,0 @@
# Go into the stocks context
stocks
# Load a ticker that's given as a first argument of the routine
load USB
# Go into the Comparison Analysis Menu
ca
# Get similar companies
set C,USB,WFC,JPM,TD,GS,PNC,TFC,BAC,COF
# Show the historical prices
historical -n
# Show a correlation matrix
hcorr
# Compare valuations
valuation
# Compare performance
performance
# Show cashflows
cashflow
# Return to home
/

View File

@@ -1,40 +0,0 @@
# Select location folder to export data to (if doesn't exist, will be created by default)
# export didier_analysis_on_$ARGV[0]
# Go into the stocks context
stocks
# Navigate to Dark Pools and Short Data Menu
dps
# Show the most shorted stocks on Yahoo Finance
shorted
# Show the stocks with the highest short interest on https://highshortinterest.com
hsi
# Show the top 25 largest Dark Pool positions from https://stockgrid.io
pos -l 25
pos -l 25 -a
# Get the Cost-to-Borrow List
ctb
# Get the days-to-cover list and sort
sidtc -s si
sidtc
# Load Apple as a ticker
load AAPL
# Short Volume vs Position
spos
# Price vs. Short Interest
psi
# Export the Cost-to-Borrow list as a spreadsheet to examine.
ctb
# Return to home
/

View File

@@ -1,38 +0,0 @@
# Select location folder to export data to (if doesn't exist, will be created by default)
# export didier_analysis_on_$ARGV[0]
# Go into the stocks context
stocks
# Load a ticker that's given as a first argument of the routine
load CF
# Enter the Due Diligence submenu
dd
# Print last twenty SEC filings
sec -l 20
# Print a chart and raw table of historical price targets
pt
pt -l 20 --raw
# See a list of public companies that are customers of, or suppliers to, CF Industries
customer
supplier
# Change tickers to $TSLA
load tsla
# Display table of the last twenty $TSLA trades across all ARK funds
arktrades -l 20
# Export a spreadsheet of historic ARK fund trades of $HOOD
load hood
arktrades --export xlsx
# Show future earnings estimates for $HOOD
est
# Show recent analyst upgrades/downgrades
analyst

View File

@@ -1,29 +0,0 @@
# Enter the discovery menu
stocks/disc
# Show a dividend calendar
divcal -l 25
# Show upcoming earnings
upcoming
# Show Ark trades
arkord
# See news from Alpha Vantage
cnews -t issuance
cnews -t m-a
# Gainers and Losers from Yahoo
gainers
losers
active
# Fidelity Order Flow
ford -l 25
# Next IPOs scheduled
fipo
# Hot Penny Stocks
hotpenny -l 25

View File

@@ -1,83 +0,0 @@
# This script requires you to use a ticker as an argument. This can be done with the following:
# exe due_diligence_stock.openbb -i AMT
# Go to the stocks menu
stocks
# Load a ticker, given the argument used. E.g. -i AMT
load $ARGV[0]
# Display stock price over time
candle
# Check market cap
fa/mktcap
# Check company management
mgmt
# Check fundamentals
income/balance/cash
# Look into sustainability
sust
# Look into historical dividends
divs
# Display most important notes of SEC filings based on a NLP model
analysis
# Create discounted cash flow spreadsheet
dcf
# show latest insider activity
../ins/stats
# check price vs short interest volume
../dps/psi
# check historical quarterly government contracts
../gov/histcont
# check rating from analysts
../dd/rating
# check price targets over time along share price
pt
# check annual earnings estimates
est
# check simple moving average 20,50 window
../ta/sma
# check recommendation and summary based on main technical analysis indicators
recom/summary
# check Twitter's sentiment on the ticker
../ba/sentiment
# go into sector and industry analysis menu
../sia
# check total cash metrics across similar tickers
metric tc
# check free cash flow metrics across similar tickers
metric fcf
# check operating income over time
vis oi
# go into comparison analysis menu
ca
# share price over time
historical
# correlation heatmap
hcorr
# compare fundamentals across these companies
cashflow/balance/income

View File

@@ -1,19 +0,0 @@
# Go into the econometrics context
econometrics
# Load the wage_panel dataset and include an alias
load wage_panel -a wp
# Set the MultiIndex, allowing for Panel regressions to be performed
index wp -i nr,year
# Change the type of the year column so it can be included as time effects within the regressions
type wp.year -f category
# Perform a Pooled OLS, Random Effects and Fixed Effects estimation
panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year
panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year -r re
panel -d wp.lwage -i wp.expersq,wp.union,wp.married,wp.year -r fe
# Compare the results obtained from these regressions
compare

View File

@@ -1,27 +0,0 @@
# Go to the stocks menu
stocks
# Load Palantir Technologies (PLTR)
load pltr
# Enter the Due Diligence (dd) menu
dd
# Show price targets, both the chart and the table
pt
pt --raw
# Enter the Insider menu
../ins
# Show open insider filtered data for Palantir Technologies
stats
# Enter the Technical Analysis (ta) menu
../ta
# Show the fibonacci retracement levels
fib
# Return to home
/

View File

@@ -1,26 +0,0 @@
# This script requires you to use arguments. This can be done with the following:
# exe example_with_inputs.openbb -i TSLA,AAPL,MSFT
# Go to the stocks menu
stocks
# Load a ticker, given the argument used. E.g. -i TSLA
load $ARGV[0]
# Enter the Technical Analysis (ta) menu
ta
# Show the fibonacci retracement levels
fib
# Enter the comparison analysis (ca) menu
../ca
# Set two extra tickers based on the arguments used. E.g. -i TSLA,AAPL,MSFT
set $ARGV[1],$ARGV[2]
# Plot the historical prices
historical
# Return to home
/

View File

@@ -1,80 +0,0 @@
# This script requires you to use an argument. This can be done with the following:
# exe routines/example_with_inputs_saved.openbb -i AMZN
# Select location folder to export data to (if doesn't exist, will be created by default)
export didier_analysis_on_$ARGV[0]
# Go into the stocks context
stocks
# Load a ticker that's given as a first argument of the routine
load $ARGV[0]
# Go into the Sector and Industry analysis
sia
# When filtering by industry peers remove market cap filtering
clear mktcap
# Compare ticker against industry peers regarding their revenues over time
vis re --export jpg
# Filter by large market cap
mktcap Large
# Compare industry peers (with large market cap) regarding their current quick ratio
metric qr --export jpg
# Take these companies to Comparison Analysis menu
ca
# Access these companies historical raw price since 2019
historical -s 2019-01-01 -n --export jpg
# Compute their correlation of price
hcorr -s 2019-01-01 --export jpg
# Compare their income statements for current year
income --export csv
# Go back one menu to the main stocks context
..
# Enter in the Dark Pool short menu
dps
# Shows stock price vs short interest volume
psi --export jpg,csv
# Go back one menu and go into Behavioural Analysis menu
../ba
# Check interest on google search of covid and quarantine correlated with ticker price
interest -s 2019-01-01 -w covid,quarantine --export interest_with_covid_quarantine.jpg
# Correlate headlines news sentiment with stock price
snews --export jpg
# Check shareholders of company (leave menu, go into Fundamental Analysis command and call command)
../fa/shrs --export csv
# Get SEC filings
../dd/sec --export csv
# Analyst ratings over time
rot --export jpg
# Price targets over time vs stock price
pt --export jpg
# Apply Relative Strength Index to the stock price
../ta/rsi --export jpg
# Get similar companies arccording to Finnhub API
../ca/getfinnhub
# Compare their volume
volume --export jpg
# Return to home
/

View File

@@ -1,47 +0,0 @@
# Demonstration of the Fundamental Analysis features, with a user-defined ticker.
# This can be done on the home menu through 'exe fa_demo.openbb -i AAPL'
# Enter stocks menu, load $ARGV[0], enter the Fundamental Analysis submenu and show a quote and overview statistics.
stocks
load $ARGV[0]
fa
quote
overview
mgmt
# NLP analysis of SEC filings
analysis
# Table of the corporate executives with links to their recent trading activity.
mgmt
# Major shareholders
shrs
# Sustainability Metrics
sust
# Performance ratios
key
enterprise -l 10
ratios -l 10
growth -l 10
metrics -l 10
# Financial Statements
income --source Polygon
income -q -l 8 --source Polygon
balance --source Polygon
balance -q -l 8 --source Polygon
cash -l 8 --source FinancialModelingPrep
data
# Charts
divs -p
splits
mktcap -s 1900-01-01
# Discount Cash Flow
dcfc -l 10
dcf

View File

@@ -1,43 +0,0 @@
# This script requires you to use arguments. This can be done with the following:
# exe routines/example_with_inputs.openbb -i TSLA,AAPL,MSFT
# Go to the Government submenu
stocks
gov
# Last Senate, Congress & House trades
lasttrades congress
lasttrades senate
lasttrades house
# Lobbying efforts
toplobbying
toplobbying -l 50 --raw
# Government spending
lastcontracts -p 1 -l 100 -s
# Load Microsoft for analysis
load msft
# Show government officials trades over six months
gtrades congress
gtrades congress --raw
gtrades senate
gtrades senate --raw
gtrades house
gtrades house --raw
# Show MSFT lobbying efforts on sigle-issue agendas
lobbying -l 20
# Historical Quarterly Government Contracts Awarded to MSFT
histcont
# Top tickers for overall trading by elected officials
topbuys congress
topbuys senate
topbuys house
topsells congress
topsells senate
topsells house

View File

@@ -1,34 +0,0 @@
# This script does not require you to use arguments.
# Go to the Insider Trading menu.
stocks
ins
# Commands not dependent on a loaded ticker
lcb
lit
lis
blcs
tispm
tippm
lip
lpsb
# Screener functions
set Gold-Silver
filter
set Retail-Trade
filter
set Guided-Missiles
filter
set Credit-Industry
filter
set Pharmaceuticals
filter
# Functions requiring a ticker
load spgi -s 2022-01-01
act
stats
lins

View File

@@ -1,58 +0,0 @@
# This script does not require you to use arguments.
# Go to the Options menu and load SPY with an expiry that is the second closest date.
stocks
options
load SPY
exp 0
# Show the chain's info
info
# Show the Put/Call Ratio with a 10, 30, and 90 day window.
pcr -l 10
pcr -l 30
pcr -l 90
# Show Open Interest and Volume
vol
oi
# Plot strike vs last trade date of puts and calls.
plot -p -x s -y ltd
plot -x s -y ltd
# Plot the volatility smile of puts and calls.
plot -c smile
plot -p -c smile
# Get chains and greeks data and export to spreadsheet.
chains --export xlsx
greeks -a -d 1.4 -r 1
greeks -p -a -d 1.4 -r 1
# Binomial pricing for $400 strike put and call.
binom -s 400
binom -p -s 400
# Run screeners
screen
set Highest_OI
scr
set Highest_Volume
scr
set Highest_IV
scr
set SPY_ATM_Calls
scr
set SPY_ATM_Poots
# Show unusual options list and export to a spreadsheet
..
unu -l 500 --export xlsx

View File

@@ -1,26 +0,0 @@
# Go to the Portfolio Optimization (po) menu
portfolio/po
# Load in an allocation sheet with all S&P 500 tickers
load SP_500_Portfolio.xlsx
# Load in a parameters file
file OpenBB_Parameters_Template_v1.0.0.xlsx
# Apply the Hierarchical Risk Parity (hrp) technique
hrp
# Show HRP results based on sector
show HRP_0 -ct SECTOR
# Plot the sector distribution
plot HRP_0 -ct SECTOR -pi
# Show a histogram of returns and drawdowns
plot HRP_0 -ct SECTOR -hi -dd
# Show assets clustermap and risk contribution
plot HRP_0 -ct SECTOR -rc -he
# Return to home
/

View File

@@ -0,0 +1,23 @@
# Go into the stocks context
stocks
# Load a company ticker, e.g. Apple
load AAPL
# Show a candle chart with a 20 day Moving Average
candle --ma 20
# Switch over to the Due Diligence menu
dd
# Show analyst ratings
analyst
# Show price targets charts
pt
# Show future estimations
est
# Return to home
home

View File

@@ -1,47 +0,0 @@
# Enter the Stock Screener menu
stocks/scr
# Top Gainers
technical -s Gap
technical -s RSI
overview -s Volume
# Strong Support Levels Preset
set stocks_strong_support_levels
overview
performance
financial
# Multiple Bottom Preset
set multiple_bottom
technical -l 15 -s RSI
# Cheap Dividend
set cheap_dividend
overview -l 20 -s Market Cap
# Potential Reversals
set potential_reversals
performance -s Perf Week
overview -s Volume
# Unusual Volume
set unusual_volume
performance -l 20 -s Volume
overview -l 20 -s Market Cap
# Value stocks
set value_stocks
overview -s Market Cap
performance
# Major News
set major_news
overview -l 20 -s Market Cap
performance -l 20 -s Volume
# Display Correlation Heat Map of the last screened tickers
ca
hcorr -t r --display-full-matrix
# Scroll back up the terminal screen to review the different outputs of the screeners

View File

@@ -1,36 +0,0 @@
# Go into the stocks context
stocks
# Load a company ticker, e.g. Amazon
load AMZN
# Show a simple plot of the ticker, adding in any basic indicator.
candle --ma 20,30
# Switch over to the due diligence menu
dd
# Show the price targets of Amazon, both the graph as well as the table
pt
pt --raw
# Show estimates of annual and quarterly earnings as well as quarterly revenue estimates
est
# Open the comparison analysis menu (ca)
../ca
# Pick stocks that are competitors to Amazon
add ebay,wmt,tgt,baba,jd
# Determine the valuations of each company
valuation
# Show correlations between each company
hcorr
# Figure out the sentiment perceived of each company
sentiment
# Return to home
/

View File

@@ -1,37 +0,0 @@
# Demonstration of the Technical Analysis features, using SPY. No arguments are required to run this routine.
# Enter stocks menu, load intraday SPY with 30 minute interval, enter the T/A menu.
stocks
load spy -i 30
ta
# Show the RSI and OBV for 30 minute intervals and weekly intervals.
rsi
obv
..
load spy -w
ta
rsi
obv
# Show one week of OBV, VWAP, Bollinger Bands, MACD, and Fibonacci Retracements with one-minute intervals.
..
load spy -i 1
ta
obv
vwap
bbands
fib
macd
# Print T/A summary
summary
# Show long chart of SPY with monthly intervals with EMA for 3 and 6 months & MACD using six months as the slow and 4 as the signal.
..
load spy -s 1993-02-01 -m
ta
ema 3,6
macd -f 1 -s 6 --signal 4
..
candle --ma 6,12

View File

@@ -1,17 +0,0 @@
# This is a comment, below you can find a command
stocks
# This is another comment
# There can be multiple lines of comments if desired
load MSFT
# You can also have multiple commands below each other
candle
fa
# You have the ability to move around menus by using /
/portfolio/po
/economy
# Returning to home is easily done with home
home

Some files were not shown because too many files have changed in this diff Show More