Go to main website Install the OpenBB Terminal

NAVIGATION

OpenBB Terminal
- stocks
  - search
  - load
  - candle
  - quote
  - news
  - codes
  - discovery
    - pipo
    - fipo
    - gainers
    - losers
    - ugs
    - gtech
    - active
    - ulc
    - asc
    - arkord
    - upcoming
    - cnews
    - trending
    - lowfloat
    - hotpenny
    - fds
    - rtat
    - divcal
    - heatmap
  - Sector and Industry Analysis (SIA)
    - load
    - clear
    - industry
    - sector
    - country
    - mktcap
    - exchange
    - cps
    - cpic
    - cpis
    - cpcs
    - cpci
    - sama
    - satma
    - metric
    - vis
    - period
  - dark pool shorts
    - shorted
    - ctb
    - hsi
    - prom
    - pos
    - sidtc
    - dpotc
    - ftd
    - spos
    - psi
  - screener
    - view
    - set
    - historical
    - overview
    - valuation
    - financial
    - ownership
    - performance
    - technical
  - insider trading
    - load
    - view
    - set
    - filter
    - lcb
    - lpsb
    - lit
    - lip
    - blip
    - blop
    - blcp
    - lis
    - blis
    - blos
    - blcs
    - topt
    - toppw
    - toppm
    - tipt
    - tippw
    - tippm
    - tist
    - tispw
    - tispm
    - lins
    - act
  - government
    - contracts
    - gtrades
    - histcont
    - lastcontracts
    - lasttrades
    - lobbying
    - qtrcontracts
    - topbuys
    - toplobbying
    - topsells
  - fundamental analysis
    - mgmt
    - analysis
    - score
    - warnings
    - dcf
    - info
    - shrs
    - sust
    - cal
    - splits
    - web
    - hq
    - divs
    - mktcap
    - overview
    - key
    - income
    - balance
    - cash
    - earnings
    - fraud
    - dupont
    - profile
    - quote
    - enterprise
    - dcfc
    - metrics
    - ratios
    - growth
  - research
    - macroaxis
    - yahoo
    - finviz
    - marketwatch
    - fool
    - businessinsider
    - fmp
    - fidelity
    - tradingview
    - marketchameleon
    - stockrow
    - barchart
    - grufity
    - fintel
    - zacks
    - macrotrends
    - newsfilter
    - stockanalysis
    - bullrun
  - due diligence
    - analyst
    - rating
    - rot
    - pt
    - est
    - sec
    - supplier
    - customer
    - arktrades
  - comparison analysis
    - ticker
    - tsne
    - getpoly
    - getfinnhub
    - getfinviz
    - historical
    - hcorr
    - volume
    - income
    - balance
    - cashflow
    - sentiment
    - scorr
    - overview
    - valuation
    - financial
    - ownership
    - performance
    - technical
  - backtesting
    - whatif
    - ema
    - ema_cross
    - rsi
  - options
    - screen
    - unu
    - calc
    - load
    - exp
    - pcr
    - info
    - chains
    - oi
    - vol
    - voi
    - hist
    - grhist
    - vsurf
    - portfolio optimization
    - parity
    - binom
    - greeks
    - hedge
      - add
      - sop
      - pick
      - list
      - rmv
    - pricing
      - add
      - rmv
      - show
      - rnval
  - trading hours
    - all
    - closed
    - exchange
    - open
    - symbol
  - technical analysis
    - view
    - tv
    - summary
    - recom
    - ema
    - sma
    - wma
    - hma
    - zlma
    - vwap
    - cci
    - macd
    - rsi
    - rsp
    - stoch
    - fisher
    - cg
    - adx
    - aroon
    - bbands
    - donchian
    - kc
    - ad
    - adosc
    - obv
    - fib
    - clenow
  - behavioural analysis
    - headlines
    - stats
    - snews
    - interest
    - wsb
    - watchlist
    - popular
    - spac_c
    - spac
    - getdd
    - reddit_sent
    - bullbear
    - messages
    - trending
    - stalker
    - infer
    - sentiment
    - mentions
    - regions
    - queries
    - rise
    - hist
    - trend
    - jcdr
    - jctr
  - quantitative analysis
    - load
    - pick
    - summary
    - normality
    - unitroot
    - hist
    - cdf
    - bw
    - acf
    - qqplot
    - rolling
    - spread
    - quantile
    - skew
    - kurtosis
    - decompose
    - cusum
    - capm
    - line
    - raw
  - prediction techniques
    - ets
    - knn
    - regression
    - arima
    - mlp
    - rnn
    - lstm
    - conv1d
    - mc
- Cryptocurrency
  - load
  - chart
  - find
  - headlines
  - prt
  - discovery
    - cgtrending
    - drnft
    - drdex
    - drdapps
    - drgames
    - cggainers
    - cglosers
    - cgtop
    - cpsearch
    - cmctop
  - tools
    - aprtoapy
    - il
  - overview
    - hm
    - ch
    - btcrb
    - cgglobal
    - cgnews
    - cgdefi
    - cgstables
    - cgexchanges
    - cgexrates
    - cr
    - cgindexes
    - cgderivatives
    - cgcategories
    - cghold
    - cpglobal
    - cpinfo
    - cpmarkets
    - cpexchanges
    - cpexmarkets
    - cpplatforms
    - cpcontracts
    - cbpairs
    - news
    - wf
    - ewf
    - wfpe
    - altindex
  - due diligence
    - active
    - change
    - eb
    - fundrate
    - oi
    - liquidations
    - ob
    - info
    - market
    - ath
    - atl
    - web
    - social
    - score
    - dev
    - bc
    - basic
    - ps
    - mkt
    - ex
    - twitter
    - events
    - balance
    - trades
    - stats
    - mcapdom
    - nonzero
    - mt
    - rm
    - tk
    - pi
    - team
    - inv
    - gov
    - fr
    - links
    - news
    - gh
  - onchain
    - btccp
    - btcct
    - gwei
    - hr
    - address
    - balance
    - hist
    - holders
    - info
    - ttcp
    - prices
    - ueat
    - baas
    - th
    - top
    - lt
    - tx
    - dvcp
    - tv
    - whales
  - nft
    - collections
    - fp
    - stats
  - technical analysis
    - ema
    - sma
    - wma
    - hma
    - zlma
    - vwap
    - cci
    - macd
    - rsi
    - stoch
    - fisher
    - cg
    - adx
    - aroon
    - bbands
    - donchian
    - kc
    - ad
    - adosc
    - obv
    - fib
    - clenow
  - defi
    - anchor
    - ldapps
    - gdapps
    - dtvl
    - stvl
    - ayr
    - aterra
    - newsletter
    - dpi
    - vaults
    - tokens
    - stats
    - pairs
    - pools
    - swaps
    - sinfo
    - govp
    - gacc
    - validators
    - sratio
    - sreturn
    - lcsc
- economy
  - overview
  - futures
  - map
  - bigmac
  - macro
  - fred
  - edebt
  - index
  - treasury
  - yield
  - ycrv
  - events
  - plot
  - rtps
  - valuation
  - performance
  - spectrum
  - prediction techniques
    - ets
    - knn
    - regression
    - arima
    - mlp
    - rnn
    - lstm
    - conv1d
    - mc
  - quantitative analysis
    - pick
    - summary
    - normality
    - unitroot
    - hist
    - cdf
    - bw
    - acf
    - qqplot
    - rolling
    - spread
    - quantile
    - skew
    - kurtosis
    - decompose
    - cusum
    - line
    - raw
- ETFs
  - ln
  - ld
  - load
  - overview
  - holdings
  - weights
  - summary
  - candle
  - news
  - disc
    - gainers
    - decliners
    - active
  - scr
    - view
    - set
    - screen
    - sbc
  - pir
  - compare
  - technical analysis
    - view
    - tv
    - summary
    - recom
    - ema
    - sma
    - wma
    - hma
    - zlma
    - vwap
    - cci
    - macd
    - rsi
    - stoch
    - fisher
    - cg
    - adx
    - aroon
    - bbands
    - donchian
    - kc
    - ad
    - adosc
    - obv
    - fib
    - clenow
  - prediction techniques
    - ets
    - knn
    - regression
    - arima
    - mlp
    - rnn
    - lstm
    - conv1d
    - mc
- funds
  - search
  - country
  - info
  - load
  - overview
  - plot
  - sector
  - equity
- portfolio
  - brokers
    - ally
      - balances
      - history
      - holdings
      - movers
      - quote
    - coinbase
      - account
      - deposits
      - history
      - orders
    - degiro
      - login
      - logout
      - hold
      - lookup
      - create
      - update
      - cancel
      - pending
      - companynews
      - lastnews
      - topnews
      - paexport
    - robinhood
      - history
      - holdings
  - portfolio optimization
    - select
    - file
    - params
      - arg
      - clear
      - file
      - save
      - set
    - load
    - add
    - rmv
    - show
    - rpf
    - plot
    - equal
    - mktcap
    - dividend
    - property
    - maxsharpe
    - minrisk
    - maxutil
    - maxret
    - maxdiv
    - maxdecorr
    - blacklitterman
    - ef
    - riskparity
    - relriskparity
    - hrp
    - herc
    - nco
  - load
  - show
  - bench
  - holdv
  - holdp
  - yret
  - mret
  - dret
  - distr
  - maxdd
  - rvol
  - rsharpe
  - rsort
  - rbeta
  - alloc
  - summary
  - metric
  - perf
  - var
  - es
  - om
- forex
  - load
  - quote
  - fwd
  - candle
  - oanda
    - calendar
    - cancel
    - candles
    - closetrade
    - orderbook
    - pending
    - positionbook
    - positions
- alternative
  - os
    - rossidx
    - tr
    - sh
    - rs
  - covid
    - slopes
    - ov
    - deaths
    - cases
    - rates
- econometrics
  - load
  - export
  - remove
  - show
  - plot
  - type
  - desc
  - index
  - clean
  - add
  - delete
  - combine
  - rename
  - ols
  - norm
  - root
  - panel
  - compare
  - dwat
  - bgod
  - bpag
  - granger
  - coint
- jupyter
  - dashboards
    - stocks
    - correlation
    - vsurf
    - chains
    - shortdata
  - reports
- common
  - technical analysis
    - view
    - tv
    - summary
    - recom
    - ema
    - sma
    - wma
    - hma
    - zlma
    - vwap
    - cci
    - macd
    - rsi
    - stoch
    - fisher
    - cg
    - adx
    - aroon
    - bbands
    - donchian
    - kc
    - ad
    - adosc
    - obv
    - fib
  - behavioural analysis
    - headlines
    - stats
    - snews
    - interest
    - wsb
    - watchlist
    - popular
    - spac_c
    - spac
    - getdd
    - reddit_sent
    - bullbear
    - messages
    - trending
    - stalker
    - infer
    - sentiment
    - mentions
    - regions
    - queries
    - rise
    - hist
    - trend
    - jcdr
    - jctr
  - quantitative analysis
    - load
    - pick
    - summary
    - normality
    - unitroot
    - hist
    - cdf
    - bw
    - acf
    - qqplot
    - rolling
    - spread
    - quantile
    - skew
    - kurtosis
    - decompose
    - cusum
    - capm
    - line
    - raw
  - prediction techniques
    - ets
    - knn
    - regression
    - arima
    - mlp
    - rnn
    - lstm
    - conv1d
    - mc
- scripts
  - exe
api
- crypto
  - tools
    - apy
    - il
  - onchain
    - top
    - ttcp
    - dvcp
    - prices
    - holders
    - gwei
    - ueat
    - baas
    - dex_trades_monthly
    - query_graph
    - balance
    - btc_supply
    - tv
    - tx
    - info
    - hist
    - whales
    - token_decimals
    - lt
    - th
    - btc_transac
    - erc20_tokens
  - nft
    - stats
  - chart
  - ov
    - crypto_hacks
    - cgderivatives
    - wfpe
    - cpinfo
    - cgcategories
    - cpmarkets
    - cpplatforms
    - platforms
    - cgstables
    - crypto_hack_slugs
    - cpexchanges
    - exchanges
    - cpcontracts
    - cr
    - cgproducts
    - cgexrates
    - cghm
    - cgdefi
    - cghold
    - cpglobal
    - cgglobal
    - altindex
    - news
    - crypto_hack
    - global_info
    - ewf
    - cpexmarkets
    - cbpairs
    - cgindexes
    - list_of_coins
    - wf
  - load
  - candles
  - disc
    - cpsearch
    - coins_for_given_exchange
    - categories_keys
    - gainers
    - top_dapps
    - gainers_or_losers
    - coins
    - losers
    - top_dexes
    - coin_list
    - trending
    - top_nfts
    - cmctop
    - top_games
  - dd
    - cbbook
    - twitter
    - inv
    - mkt
    - change
    - mt
    - gh
    - ohlc_historical
    - exchanges
    - trades
    - eb
    - btcrb
    - headlines
    - ex
    - basic
    - tk
    - get_mt
    - balance
    - pr
    - all_binance_trading_pairs
    - check_valid_binance_str
    - pi
    - ps
    - coin
    - news
    - candles
    - team
    - links
    - trading_pair_info
    - binance_available_quotes_for_each_coin
    - book
    - hr
    - show_available_pairs_for_given_symbol
    - fr
    - mcapdom
    - active
    - events
    - nonzero
    - oi
    - tokenomics
    - rm
    - trading_pairs
    - stats
    - coin_market_chart
    - gov
  - find
  - defi
    - sratio
    - gacc
    - pools
    - sinfo
    - newsletters
    - anchor_data
    - sreturn
    - pairs
    - dpi
    - swaps
    - ldapps
    - luna_supply
    - vaults
    - stvl
    - ayr
    - validators
    - dtvl
    - tokens
    - gov_proposals
    - stats
    - gdapps
    - aterra
- economy
  - gdpc
  - gdp
  - macro_parameters
  - indices
  - currencies
  - bigmac
  - fred_notes
  - futures
  - cpi
  - get_events_countries
  - search_index
  - country_codes
  - unemp
  - get_ycrv_countries
  - glbonds
  - available_indices
  - ycrv
  - inf
  - rtps
  - fred_series
  - treasury_maturities
  - macro
  - usbonds
  - index
  - fred_yield_curve
  - tyld
  - spectrum
  - macro_countries
  - treasury
  - events
  - performance
  - overview
  - valuation
  - future
  - perfmap
  - fred_ids
- forex
  - quote
  - candle
  - get_currency_list
  - load
  - oanda
    - fwd
    - order
    - cancel
    - calendar
    - close
    - listorders
    - openpositions
    - opentrades
    - price
    - candles
    - orderbook
    - positionbook
    - summary
    - pending
  - hist
- econometrics
  - options
  - panel
  - bgod
  - bpag
  - bols
  - fe
  - fdols
  - coint
  - pols
  - granger
  - clean
  - norm
  - load
  - get_regression_data
  - root
  - dwat
  - comparison
  - re
  - ols
- stocks
  - options
    - vsurf
    - pcr
    - last_price
    - chains_yf
    - hedge
    - hist_tr
    - option_chain
    - hist_ce
    - y_values
    - process_chains
    - vol_yf
    - info
    - dte
    - price
    - grhist
    - screen
      - screener_output
      - check_presets
    - unu
    - voi_yf
    - dividend
    - generate_data
    - chains
    - option_expirations
    - closing
    - x_values
  - screener
    - historical
    - screener_data
  - quote
  - candle
  - sia
    - sectors
    - filter_stocks
    - cps
    - industries
    - cpic
    - maketcap
    - stocks_data
    - countries
    - cpci
    - cpis
    - cpcs
  - ca
    - scorr
    - polygon_peers
    - screener
    - income
    - balance
    - finviz_peers
    - cashflow
    - finnhub_peers
    - hist
    - sentiment
    - volume
    - hcorr
  - qa
  - dps
    - prom
    - ftd
    - psi_sg
    - shorted
    - dpotc
    - pos
    - sidtc
    - volexch
    - ctb
    - hsi
    - psi_q
    - spos
  - search
  - ins
  - load
  - ba
    - wsb
    - cnews
    - spac
    - regions
    - messages
    - snews
    - spac_c
    - stalker
    - trend
    - reddit_sent
    - headlines
    - queries
    - mentions
    - text_sent
    - getdd
    - bullbear
    - popular
    - infer
    - hist
    - trending
    - cramer_ticker
    - cramer
    - sentiment
    - rise
    - watchlist
  - bt
    - ema
    - rsi
    - ema_cross
  - disc
    - asc
    - ipo
    - gainers
    - gtech
    - hotpenny
    - losers
    - news
    - ugs
    - lowfloat
    - rtat
    - pipo
    - trending
    - upcoming
    - ulc
    - active
    - dividends
    - arkord
    - fipo
  - dd
    - rot
    - rating
    - analyst
    - sec
    - pt
    - news
    - supplier
    - est
    - arktrades
    - customer
  - fa
    - mgmt
    - av_income
    - analysis
    - enterprise
    - hq
    - quote
    - fraud
    - dupont
    - website
    - av_overview
    - poly_financials
    - shrs
    - sust
    - historical_5
    - fmp_cash
    - fmp_income
    - cal
    - growth
    - av_balance
    - info
    - score
    - yf_financials
    - profile
    - mktcap
    - earnings
    - fmp_metrics
    - similar_dfs
    - divs
    - dcf
    - fmp_balance
    - fmp_ratios
    - av_cash
    - data
    - av_metrics
    - fama_raw
    - fama_coe
    - splits
  - process_candle
  - ta
    - recom
    - view
    - summary
  - th
    - exchange
    - check_if_open
    - all
    - closed
    - open
  - gov
    - topbuys
    - lobbying
    - government_trading
    - contracts
    - topsells
    - lasttrades
    - histcont
    - toplobbying
    - lastcontracts
    - gtrades
    - qtrcontracts
- common
  - behavioural_analysis
    - sentiment_stats
    - sentiment
  - qa
    - skew
    - bw
    - rolling
    - calculate_adjusted_var
    - sharpe
    - quantile
    - var
    - spread
    - kurtosis
    - unitroot
    - sortino
    - omega
    - es
    - decompose
    - summary
    - normality
  - news
  - ta
    - ema
    - obv
    - fisher
    - aroon
    - kc
    - ad
    - wma
    - ma
    - sma
    - cg
    - rsi
    - hma
    - macd
    - stoch
    - bbands
    - donchian
    - vwap
    - zlma
    - adx
    - fib
    - adosc
    - cci
- portfolio
  - dret
  - skew
  - information
  - calmar
  - maxdd
  - rsquare
  - payoff
  - sharpe
  - yret
  - rsharpe
  - jensens
  - kelly
  - om
  - profitfactor
  - volatility
  - trackerr
  - var
  - tail
  - kurtosis
  - po
    - plot
    - maxdecorr
    - get_properties
    - meanrisk
    - property
    - herc
    - maxdiv
    - maxsharpe
    - maxret
    - load_bl_views
    - hrp
    - load
    - riskparity
    - hcp
    - blacklitterman
    - nco
    - equal
    - minrisk
    - ef
    - maxutil
    - relriskparity
  - rsortino
  - sortino
  - mret
  - rbeta
  - max_drawdown_ratio
  - gaintopain
  - es
  - maxdrawdown
  - commonsense
  - rvol
  - perf
  - distr
  - holdp
  - summary
  - holdv
- etf
  - ld
  - candle
  - weights
  - scr
    - screen
  - holdings
  - etf_by_name
  - load
  - news
  - disc
    - mover
  - symbols
  - ln
  - etf_by_category
  - overview
  - summary
- funds
  - search
  - info
  - overview
- alt
  - oss
    - top
    - top_repos
    - repo_summary
    - stars_history
    - search
    - _make_request
    - history
    - _retry_session
    - search_repos
    - github_data
    - summary
    - ross
  - covid
    - slopes
    - global_deaths
    - ov
    - global_cases
    - stat
    - case_slopes

MORE

Go to main website
Go to Bot Docs
Install the Terminal
Fill in the Survey
View Source
License
Contributing

OpenBB Terminal Documentation
/
OpenBB Python API
/
crypto

Edit this page

crypto

api tools

Built with Hugo and

Back to top