mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-29 13:32:08 +00:00
Features 📈
Table of contents
- Discover Stocks
- Behavioural Analysis
- Research
- Fundamental Analysis
- Technical Analysis
- Due Diligence
- Prediction Techniques
- Portfolio Analysis
- Portfolio Optimization
- Cryptocurrencies
- Comparison Analysis
- Exploratory Data Analysis
- Residual Analysis
- Economy
- Options
- Screener
- Forex
- Backtesting
- Resource Collection
Main
The main menu allows the following commands:
load -t S_TICKER [-s S_START_DATE] [-i {1,5,15,30,60}]
- 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.
- -s : The starting date (format YYYY-MM-DD) of the stock
- -i : Intraday stock minutes
- --source : Source of historical data. 'yf' and 'av' available. Default 'yf'
- -p : Pre/After market hours. Only works for 'yf' source, and intraday data
Note: Until a ticker is loaded, the menu will only show disc and sen menu, as the others require a ticker being provided.
clear
- Clear previously loaded stock ticker.
view -t S_TICKER [-s S_START_DATE] [-i {1,5,15,30,60}] [--type N_TYPE]
- Visualise historical data of a stock. An alpha_vantage key is necessary.
- -s : The starting date (format YYYY-MM-DD) of the stock
- -i : Intraday stock minutes
- --type : 1234 corresponds to types: 1. open; 2. high; 3.low; 4. close; while 14 corresponds to types: 1.open; 4. close
candle
- Visualize candles historical data from the past 6 months, with support and resistance bars, and moving averages of 20 and 50
export -f GNUS_data -F csv
- Exports the historical data from this ticker to a file or stdout.
- -f : Name of file to save the historical data exported (stdout if unspecified). Default: stdout.
- -F : Export historical data into following formats: csv, json, excel, clipboard. Default: csv.
Discover Stocks »
| Command | Description | Source |
|---|---|---|
map |
S&P500 index stocks map | Finviz |
rtp_sectors |
real-time performance sectors | Alpha Vantage |
gainers |
show latest top gainers | Yahoo Finance |
losers |
show latest top losers | Yahoo Finance |
orders |
orders by Fidelity Customers | Fidelity |
ark_orders |
orders by ARK Investment Management LLC | Cathiesark |
up_earnings |
upcoming earnings release dates | Seeking Alpha |
high_short |
show top high short interest stocks of over 20% ratio | High Short Interest |
low_float |
show low float stocks under 10M shares float | Low Float |
simply_wallst |
Simply Wall St. research data | Simply Wall St. |
spachero |
great website for SPACs research | SpacHero |
uwhales |
good website for SPACs research | UnusualWhales |
valuation |
valuation of sectors, industry, country | Finviz |
performance |
performance of sectors, industry, country | Finviz |
spectrum |
spectrum of sectors, industry, country | Finviz |
latest |
latest news | Seeking Alpha |
trending |
trending news | Seeking Alpha |
ratings |
top ratings updates | MarketBeat |
darkpool |
dark pool tickers with growing activity | FINRA |
Behavioural Analysis »
| Command | Description |
|---|---|
| FinBrain | |
finbrain |
sentiment from 15+ major news headlines |
wsb |
show what WSB gang is up to in subreddit wallstreetbets |
watchlist |
show other users watchlist |
popular |
show popular tickers |
spac_c |
show other users spacs announcements from subreddit SPACs community |
spac |
show other users spacs announcements from other subs |
| Stocktwits | |
bullbear |
estimate quick sentiment from last 30 messages on board |
messages |
output up to the 30 last messages on the board |
trending |
trending stocks |
stalker |
stalk stocktwits user's last message |
infer |
infer about stock's sentiment from latest tweets |
sentiment |
in-depth sentiment prediction from tweets over time |
mentions |
interest over time based on stock's mentions |
regions |
regions that show highest interest in stock |
queries |
top related queries with this stock |
rise |
top rising related queries with stock |
Research »
| Command | Website |
|---|---|
macroaxis |
www.macroaxis.com |
yahoo |
www.finance.yahoo.com |
finviz |
www.finviz.com |
marketwatch |
www.marketwatch.com |
fool |
www.fool.com |
businessinsider |
www.markets.businessinsider.com |
fmp |
www.financialmodelingprep.com |
fidelity |
www.eresearch.fidelity.com |
tradingview |
www.tradingview.com |
marketchameleon |
www.marketchameleon.com |
stockrow |
www.stockrow.com |
barchart |
www.barchart.com |
grufity |
www.grufity.com |
fintel |
www.fintel.com |
zacks |
www.zacks.com |
macrotrends |
www.macrotrends.net |
newsfilter |
www.newsfilter.io |
stockanalysis |
www.stockanalysis.com |
Fundamental Analysis »
| Command | Description |
|---|---|
screener |
screen info about the company (Finviz) |
mgmt |
management team of the company (Business Insider) |
score |
investing score from Warren Buffett, Joseph Piotroski and Benjamin Graham (FMP) |
| Market Watch API | |
income |
income statement of the company |
balance |
balance sheet of the company |
cash |
cash flow statement of the company |
| Yahoo Finance API | |
info |
information scope of the company |
shrs |
shareholders of the company |
sust |
sustainability values of the company |
cal |
calendar earnings and estimates of the company |
| Alpha Vantage API | |
overview |
overview of the company |
income |
income statements of the company |
balance |
balance sheet of the company |
cash |
cash flow of the company |
earnings |
earnings dates and reported EPS |
| Financial Modeling Prep API | |
profile |
profile of the company |
quote |
quote of the company |
enterprise |
enterprise value of the company over time |
dcf |
discounted cash flow of the company over time |
income |
income statements of the company |
balance |
balance sheet of the company |
cash |
cash flow of the company |
metrics |
key metrics of the company |
ratios |
financial ratios of the company |
growth |
financial statement growth of the company |
Technical Analysis »
| Command | Description | Sources |
|---|---|---|
view |
view historical data and trendlines | Finviz |
summary |
technical summary report | FinBrain |
recom |
recommendation based on Technical Indicators | Tradingview |
| overlap | ||
ema |
exponential moving average | Wikipedia, Investopedia |
sma |
simple moving average | Wikipedia, Investopedia |
vwap |
volume weighted average price | Wikipedia, Investopedia |
| momentum | ||
cci |
commodity channel index | Wikipedia, Investopedia |
macd |
moving average convergence/divergence | Wikipedia, Investopedia |
rsi |
relative strength index | Wikipedia, Investopedia |
stoch |
stochastic oscillator | Wikipedia, Investopedia |
| trend | ||
adx |
average directional movement index | Wikipedia, Investopedia |
aroon |
aroon indicator | Investopedia |
| volatility | ||
bbands |
bollinger bands | Wikipedia, Investopedia |
| volume | ||
ad |
chaikin accumulation/distribution line values | Wikipedia, Investopedia |
obv |
on balance volume | Wikipedia, Investopedia |
Due Diligence »
| Command | Description | Source |
|---|---|---|
news |
latest news of the company | Finviz |
red |
gets due diligence from another user's post | |
analyst |
analyst prices and ratings of the company | Finviz |
rating |
rating of the company from strong sell to strong buy | FMP |
pt |
price targets over time | Business Insider |
est |
quarter and year analysts earnings estimates | Business Insider |
ins |
insider activity over time | Business Insider |
insider |
insider trading of the company | Finviz |
sec |
SEC filings | MarketWatch |
short |
short interest | Quandl |
warnings |
company warnings according to Sean Seah book | MarketWatch |
dp |
dark pools (ATS) vs OTC data FINRA | |
ftd |
display fails-to-deliver data SEC |
Prediction Techniques »
| Command | Technique | Sources |
|---|---|---|
sma |
simple moving average | Wikipedia, Investopedia |
knn |
k-Nearest Neighbors | Wikipedia |
linear |
linear regression (polynomial 1) | Wikipedia, Investopedia |
quadratic |
quadratic regression (polynomial 2) | Wikipedia, Investopedia |
cubic |
cubic regression (polynomial 3) | Wikipedia, Investopedia |
regression |
regression (other polynomial) | Wikipedia, Investopedia |
arima |
autoregressive integrated moving average | Wikipedia, Investopedia |
prophet |
Facebook's prophet prediction | Details |
mlp |
MultiLayer Perceptron | Wikipedia |
rnn |
Recurrent Neural Network | Wikipedia |
lstm |
Long Short-Term Memory | Wikipedia, Details |
Portfolio Analysis »
| Command | Description | Brokers |
|---|---|---|
login |
login to your brokers | |
rhhold |
view robinhood holdings | Robinhood |
rhhist |
plot robinhood portfolio history | Robinhood |
alphold |
view alpaca holdings | Alpaca |
alphist |
view alpaca portfolio history | Alpaca |
allyhold |
view ally holdings | Ally |
hold |
view net holdings across all logins |
Portfolio Optimization »
| Command | Description |
|---|---|
add |
add ticker to optimize |
select |
overwrite current tickers with new tickers |
equal |
equally weighted |
property |
weight according to selected info property (e.g. marketCap) |
maxsharpe |
optimizes for maximal Sharpe ratio (a.k.a the tangency portfolio) |
minvol |
optimizes for minimum volatility |
maxquadutil |
maximises the quadratic utility, given some risk aversion |
effret |
maximises return for a given target risk |
effrisk |
minimises risk for a given target return |
ef |
show the efficient frontier |
Cryptocurrency »
| Command | Description |
|---|---|
| coingecko | |
load |
load cryptocurrency data |
view |
view loaded cryptocurrency data |
trend |
view top 7 coins |
| coinmarketcap | |
top |
view top coins from coinmarketcap |
| binance | |
add |
add binance ticker |
book |
show order book |
candle |
get klines/candles and plot |
balance |
show coin balance |
Comparison Analysis »
| Command | Description | Source |
|---|---|---|
get |
get similar companies | Polygon |
select |
select similar companies | |
historical |
historical price data comparison | Yahoo Finance |
hcorr |
historical price correlation | Yahoo Finance |
income |
income financials comparison | MarketWatch |
balance |
balance financials comparison | MarketWatch |
cashflow |
cashflow comparison | MarketWatch |
sentiment |
sentiment analysis comparison | FinBrain |
scorr |
sentiment correlation | FinBrain |
Exploratory Data Analysis »
| Command | Description | Source |
|---|---|---|
get |
get similar companies | Polygon |
select |
select similar companies | |
historical |
historical price data comparison | Yahoo Finance |
hcorr |
historical price correlation | Yahoo Finance |
income |
income financials comparison | MarketWatch |
balance |
balance financials comparison | MarketWatch |
cashflow |
cashflow comparison | MarketWatch |
sentiment |
sentiment analysis comparison | FinBrain |
scorr |
sentiment correlation | FinBrain |
Residual Analysis »
| Command | Description | Source |
|---|---|---|
pick |
pick one of the model fitting | Supports ARIMA, Naive |
fit |
show model fit against stock | Wikipedia |
res |
show residuals | Wikipedia |
hist |
histogram and density plot | Wikipedia |
qqplot |
residuals against standard normal curve | Wikipedia |
acf |
(partial) auto-correlation function | Wikipedia |
normality |
normality test (Kurtosis,Skewness,...) | Wikipedia |
goodness |
goodness of fit test (Kolmogorov-Smirnov) | Wikipedia |
arch |
autoregressive conditional heteroscedasticity | Wikipedia |
unitroot |
unit root test / stationarity (ADF, KPSS) | Wikipedia |
independence |
tests independent and identically distributed (BDS) | Wikipedia |
Economy »
| Command | Description |
|---|---|
vixcls |
Volatility Index |
gdp |
Gross Domestic Product |
unrate |
Unemployment Rate |
dgs1 |
1-Year Treasury Constant Maturity Rate |
dgs5 |
5-Year Treasury Constant Maturity Rate |
dgs10 |
10-Year Treasury Constant Maturity Rate |
dgs30 |
30-Year Treasury Constant Maturity Rate |
mortgage30us |
30-Year Fixed Rate Mortgage Average |
fedfunds |
Effective Federal Funds Rate |
aaa |
Moody's Seasoned AAA Corporate Bond Yield |
dexcaus |
Canada / U.S. Foreign Exchange Rate (CAD per 1 USD) |
Options »
| Command | Description | Source |
|---|---|---|
exp |
see/set expiry date | |
volume |
volume + open interest options trading plot | Yahoo Finance |
vcalls |
calls volume + open interest plot | Yahoo Finance |
vputs |
puts volume + open interest plot | Yahoo Finance |
chains |
displays option chains | Tradier |
info |
display option information | Barchart |
Screener »
| Command | Description | Source |
|---|---|---|
| view | view available presets | presets |
| set | set one of the available presets | |
| historical | view historical price | Yahoo Finance |
| Finviz | ||
| overview | overview (e.g. Sector, Industry, Market Cap, Volume) | |
| valuation | valuation (e.g. P/E, PEG, P/S, P/B, EPS this Y) | |
| financial | financial (e.g. Dividend, ROA, ROE, ROI, Earnings) | |
| ownership | ownership (e.g. Float, Insider Own, Short Ratio) | |
| performance | performance (e.g. Perf Week, Perf YTD, Volatility M) | |
| technical | technical (e.g. Beta, SMA50, 52W Low, RSI, Change) | |
| signals | view filter signals (e.g. -s top_gainers) |
Forex »
| Command | Description |
|---|---|
| summary | display a summary of your account |
| calendar | get information about past or upcoming events which may impact the price |
| list | list your order history |
| pending | get information about pending orders |
| cancel | cancel a pending order by ID |
| positions | get information about your positions |
| trades | see a list of open trades |
| closetrade | close a trade by ID |
| load | specify an instrument to use |
| candles | get a candlestick chart for the forex instrument |
| price | show the current price for the forex instrument |
| order | place a limit order |
| orderbook | display the orderbook if Oanda provides one for the forex instrument |
| positionbook | display the positionbook if Oanda provides one for the forex instrument |
Backtesting »
| Command | Description |
|---|---|
ema |
buy when price exceeds EMA(l) |
ema_cross |
buy when EMA(short) > EMA(long) |
rsi |
buy when RSI < low and sell when RSI > high |
Resource Collection »
| Command | Website |
|---|---|
hfletters |
https://miltonfmr.com/hedge-fund-letters/ |
learn |
https://moongangcapital.com/free-stock-market-resources/ |

