jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-08 10:22:09 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
8dacef0bf0a025b6794de271bbc4cacfbc8df16a
OpenBB/gamestonk_terminal/cryptocurrency/discovery/README.md
Didier Rodrigues Lopes a85758c9ec Big UX improvement (#1041) 
Co-authored-by: jmaslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* improve user experience phase 1

* add difflib replacement

* implement auto-complete on discovery menu

* auoto-complete, difflib,jump through menus with cd

* Updating tests : terminal

* improve navigation on gst

* add q command to terminal.py

* usage instructions

* Updating tests : terminal

* fix cd command

* vars updated

* show menu when user is going through menus

* allow user to forget the intiail / on scripting

* terminal to accept text file with configuration

* refactor -n to -l and clean code

* add all commands to the tests_stocks_disc

* remove fds from disc since we have search on stocks/ and stocks/sia

* hopefully fix tests

* skip test

* fix completer type and calling menu after command for stocks/disc

* show help menu when moving forward/backwards in menus

* skip test

* skip test - bug fix

* add reset, help and quit to choices

* improve stocks/disc controller

* refactor sia menu

* UX improvements for sia menu

* improve ux design

* refactor ca controller

* fix infinite loop

* improve ux on dps controller

* Add capability of going back from a menu going into a menu

* Ux economy (#1056)

* First round of UX improvements on economy menu

* Do fred menu + sample tests file

* revert to > on menu

* rename jobs file to .gst

* remove cd option

* improve return

* final refactoring of disc_controller

* fix ca,dps,sia,disc,stocks and terminal controllers

* work on ba_controller menu

* fix reset and try_except

* UX on screener controller

* fix for full reset name

* Ux etfs (#1059)

* Refactor ETF menu for new UX

* Add couple more examples to test

* r->reset

* Clean up switch

* gov menu refactored

* fix reset issue

* 80% of refactoring options and pricing/payoff menu is done

* improve payoff controller

* minor fix

* fix: refactor pred and ta stocks controller

* fix: refactor fa(and fmp) controllers

* fix: refactored dd controller (still missing .gst tests)

* fix infinite loop bug

* refactor options controller

* add tests for payoff and pricing

* fix reset for options

* UX Upgrade for Crypto controller(s) (#1049)

* refactor crypto controller

* refactor crypto/defi controller

* added simple test and fixes not returning queue in commands

* Clean up unused functions / iex load (#1047)

* Clean up unused functions and adjust iex load function to not depend on dates

* Had an incorrect tab on s_start definition

* wrong default arg

* regenerate pytest yml

* Comment out parametrization

* Tests : Stocks > Discovery (#1050)

* Updating tests : stocks/discovery/ark

* Updating tests : stocks/discovery/fidelity

* Updating tests : stocks/discovery/fidelity

* Updating tests : stocks/discovery/fidelity

* Updating tests : stocks/discovery/seeking_alpha

* Updating tests : stocks/discovery/seeking_alpha

* Updating tests : stocks/discovery/shortinterest

* Updating tests : stocks/discovery/shortinterest

* Updating tests : stocks/discovery/seeking_alpha

* Updating tests : stocks/discovery/shortinterest

* Updating tests : stocks/discovery/disc_controller

* Updating tests : stocks/dd

* Updating tests : stocks/fa

* Updating tests : stocks/discovery/financedatabase

* Updating tests : stocks/discovery/finnhub

* Updating tests : stocks/discovery/geekofwallstreet

* Updating tests : stocks/discovery/marketbeat

* Updating tests : stocks/discovery/nasdaq

* Updating tests : stocks / discovery / yahoofinance

* Updating tests : black

* Updating tests : unused import

* Updating tests : stocks/discovery/ark

* Tests : Stocks > Doc + Helpers + Government (#1051)

* Updating tests : stocks/government/controller

* Updating tests : stocks/government

* Updating tests : conftest

* Updating tests : stocks > government

* Updating tests : stocks/government

* Updating tests : docs

* Tests : Stocks > Insider (#1054)

* Updating tests : stocks > helper

* Updating tests : doc

* Updating tests : clean stocks > fa > av

* Updating tests : stocks/insider/controller

* Updating tests : stocks/insider/business insider

* Updating tests : stocks/insider/finviz

* Updating tests :  stocks/insider/openinsider

* Updating tests :  stocks/insider/controller

* Updating tests : black

* Updating tests : stocks/insider/controller

* Tests : Stocks > Backtesting + Behavioural Analysis  (#1057)

* Updating tests : add __init__ files

* Updating tests : stocsk/behavioural_analysis

* Updating tests : black

* Updating tests : stocks/backtesting

* Updating tests : stocks/backtesting

* fix: converted top to limit arguments

* fix: refactor disc controller, updated docs

* fix: refactor dd_controller and docs

* fix: refactor nft controller and docs

* fix: pass test temporarily, onchain controller refactor, docs

* fix: overview controller refactor, fix quit command

* fix: linting issues

* fix: refacot ta controller

* fix: refactor pred controller

* fix: linting

* fix: crypto controller

* fix: added tests, updated all controlers

* fix: menu print renamed from stocks to crypto controller, added tests

* fix: fix faster function execution

* Fix annoying pylint C0201 error

* fix: renamed commands to long format

* DISC Cleanup (#1058)

* Get rid/cleanup of marketbeat functions

* Get rid of last unused disc function + fix related tests

* fix test

* Dividend History Chart (#1053)

* Dividend History Chart

* changed to default number 10

* changed divs flag default to false

* updating the expected result for test_fa_controller.

* else statement

* fix: added load on dd

* fix: added autocompletion in all commands with argument choices

* fix: linting

* Workflows + Stocks > Insider (#1061)

* Updating code : stocks/insider remove unused file

* Updating workflows : tests - set mypy==0.910

* fix: linting

* Fixing Linting (#1062)

* Updating code : fixing linting

mypy message = Too many arguments for <lambda>

* Updating workflows : allow newest mypy version

* Updating code : apply black

* Updating code : black

* fix: updated predict controller help to match stocks

* Ux: portfolio (#1063)

* First step of portfolio UX

* Add all broker controllers to UX stuff

* UX Improvement for PO

Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* UX Improvement for resources (#1064)

Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* UX: stock/bt (#1065)

* UX: stocks>qa (#1068)

* fix mypy lambda

* skip tests for now

* remove unused paths.py

* rename tests/simulator to tests/e2e

* refactor options/screener menu

* UX : move `gst` files location

* fix stocks_controller

* UX upgrade of the Forex menu (#1048)

* Add basic forex menu test

* Add forex routes to terminal paths

* Remove commands from paths because they're not menus

* WIP Refactor forex controller

* refactor crypto controller

* Remove commented code

* Improve user output with printed text

* Add "help" back to the list of choices

* Enable the command queue for the forex controller

* refactor crypto/defi controller

* Fix candle chart blocking the terminal

* Black

* Return help and reset to the list of known args

* added simple test and fixes not returning queue in commands

* Add currency codes loading to the av_model

* Return the queue in edge cases (when commands don't process)

* Split select into to and from to enable autocompletion

* Style text output

* Stop printing help after the execution of every command

* Update test scenarios

* Black

* fix: converted top to limit arguments

* fix: refactor disc controller, updated docs

* Delete oanda the old view file that was moved into the oanda menu

* fix: refactor dd_controller and docs

* fix: refactor nft controller and docs

* fix: pass test temporarily, onchain controller refactor, docs

* fix: overview controller refactor, fix quit command

* fix: linting issues

* fix: refacot ta controller

* fix: refactor pred controller

* fix: linting

* fix: crypto controller

* fix: added tests, updated all controlers

* fix: menu print renamed from stocks to crypto controller, added tests

* fix: fix faster function execution

* Implement basic UX improvement of the oanda controller

* Update the forex controller

* Fix annoying pylint C0201 error

* Add latest convention changes to the forex controller

* fix: renamed commands to long format

* fix: added load on dd

* Merge the latest updates of the controller design

* fix: added autocompletion in all commands with argument choices

* fix: linting

* fix: linting

* fix: updated predict controller help to match stocks

* Update the forex menu e2e test scripts

* Add check_non_negative_float helper

* Update the controller with the latest changes to the convention

* Update the currency pair loading mechanism

* Move data models logic to the models file

* Update update oanda views to be interact with the models

* Upgrade oanda controller

* Remove raw stocks ba and eda code from the forex menu

* Update "help wanted" banner for ba and eda in forex menu

* Remove remainders of stocks ba and eda from forex context

* Improve typing, docstrings and error messages

* Remove stocks ba and eda code that was merged from other ux branches

* Add fixes that prevented incorrect argument handling

* Remove -argument from the candles call
If there is an expected agr `-g` and you put an incorrect argument
`-argument` the difflib will interpret `argument` as `g`

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: Didier Rodrigues Lopes <dro.lopes@campus.fct.unl.pt>

* fix reset for menus that require ticker

* UX improvement on research menu

* skip insider controller test

* initial refactoring of insider_controller

* improve insider controller ux part 2

* finish refactoring ins controller ux menu

* fix bug of when commands in queue have args

* skip test

* comment test stuff

* UX: stocks>qa (#1071)

* refactor return self.queue

* fix return None

* minor fix

* minor tabulate fix

* Get rid of leading '/' in terminal and add some newlines on quits. (#1074)

* Get rid of leading '/' in terminal and add some newlines on quits.

* print crypto help on menu entry

* looks like a format issue here...

* newlines on quit

* remove unnecessary line break

* fix pylint issue

* refactor

* refactor

* allow portfolio optimization to quit context

* add exit at end of scripts

* improve dd_controller

* test ux in stocks/dd menu

* Ux upgrade for reports context (#1075)

* Refactor reports and upgrade them with the latest controller convention

* Add test scenarios for the reports context

* test ux stocks/ta

* ux branch scripts/ta

* improvement on main param

* Upgrades for the UX upgrade for the fa and fa/fmp menus (#1076)

* Change --num to --limit

* Remove inconsistent/unreliable functions from the choices list

* Improve docstring compliance with numpy doc format

* Fix hardcoded class id in dcf scrapper

* Fix annoying pylint error in discordbot that was blocking the hook

* Add test scenarios for the fa and fa/fmp menus

* Fix forgotten replacement of --num to --limit

* Fix tests

* Return some excluded commands to the choices list

* Fix dd report to reflect the updates

* Fix set function not returning the queue

* Update gst test files

* fix exit on ca from another submenu

* fix changes of options/screener

* fix dps controller

* fix fa when running out of AV calls

* Fix TVL plot locking interpreter during defi test

* Add exception handling for broken coingecko scrapper

* skip fa/av test that fails

* fix dps tests

Co-authored-by: Chavithra PARANA <chavithra@gmail.com>
Co-authored-by: jmaslek <jmaslek11@gmail.com>
Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
2021-12-21 15:19:23 +03:00

15 KiB
Vendored
Raw Blame History

DISCOVERY CRYPTO

This menu aims to discover crypto currencies. You can find the most trending coins, top nfts, best defi tokens and many others. The usage of the following commands along with an example will be exploited below.

CoinGecko

CoinPaprika

CoinMarketCap

  • cmc_top
    • show top coin from coinmarketcap.com

Binance

CoinGecko

cg_coins 

usage: cg_coins [-s --skip] [-t --top] [-l --letter] [-k --key]

Display all available coins in coingecko. You can search with pagination mechanism with cg_coins --skip [num] --top [num] or you can just search by letter like cg_coins --letter d --key name --top 10 it will display top 10 matches for coins which name starts with letter d and search will be done in column name

  • -s/--skip - number of records to skip. Default is 0. There are thousands of coins, so there is mechanism to paginate through them. e.q if you want to see only records from 500-750 you should use cg_coins --skip 500 --top 250 or if you want to see 1200-1880 you should use coins --skip 1200 --top 680.
  • -t/--top - number of news to display. One page of news contains 25 news, so to get 250 news script needs to scrape 10 pages (it can take some time). Default 100. E.g news --top 150
  • -l/--letter - first letters of coin by which you want to search
  • -k/--key - search key. With this parameter you can specify in which column you would like to search. Choose on from name, id, symbol

image

cg_trending 

usage: cg_trending [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows most trending coins on CoinGecko.

  • -t/--top - number of coins to display. To display top 10 coins: cg_trending --top 10
  • -s/--sortby - sort by given column. You can chose on from rank, name, price_usd, price_btc
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_trending --top 10 --urls

image

cg_most_voted 

usage: cg_most_voted [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows most voted coins on CoinGecko.

  • -t/--top - number of coins to display. To display top 10 coins: cg_most_voted --top 10
  • -s/--sortby - sort by given column. You can chose on from rank, name, price_usd, price_btc
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_most_voted --top 10 --urls

image

cg_most_visited 

usage: cg_most_visited [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows most visited coins on CoinGecko.

  • -t/--top - number of coins to display. To display top 10 coins: cg_most_visited --top 10
  • -s/--sortby - sort by given column. You can chose on from rank, name, price_usd, price_btc
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_most_visited --top 10 --urls

image

cg_sentiment 

usage: cg_sentiment [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows coins with the most positive sentiment on CoinGecko

  • -t/--top - number of coins to display. To display top 10 coins: cg_sentiment --top 10
  • -s/--sortby - sort by given column. You can chose on from rank, name, price_usd, price_btc
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_sentiment --top 10 --urls

image

cg_recently 

usage: cg_recently [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows coins which were recently added on CoinGecko

  • -t/--top - number of coins to display. To display top 10 coins: cg_recently --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can chose on from rank, name, symbol, price, change_24h, change_1h, added
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_recently --top 10 --urls

image

cg_top_volume 

usage: cg_top_volume [-t --top] [-s --sortby] [--descend]

Shows coins with the highest transactions volume on CoinGecko

  • -t/--top - number of coins to display. To display top 10 coins: cg_top_volume --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can chose on from rank, name, symbol, price, change_1h, change_24h, change_7d , volume_24h
  • --descend - flag to sort in descending order (lowest first)

image

cg_gainers 

usage: cg_gainers [-p --period] [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows largest gainers - coins which gain the most in given period.

  • -p/--period - time period in which coins gained the most in price. One from 1h, 24h, 7d, 14d, 30d, 60d, 1y. If you want to see top gainers in last 24h cg_gainers -p 24h or top gainers in last 60days cg_gainers -p 60d
  • -t/--top - number of coins to display. To display top 10 coins: cg_gainers --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can chose on from rank, name, symbol, price, change, volume.
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_gainers --period 24h --urls

image

cg_losers 

usage: cg_losers [-p --period] [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows largest losers - coins which lost the most in given period.

  • -p/--period - time period in which coins lost the most in price. One from 1h, 24h, 7d, 14d, 30d, 60d, 1y. If you want to see top losers in last 24h cg_losers -p 24h or top losers in last 60days cg_losers -p 60d
  • -t/--top - number of coins to display. To display top 10 coins: cg_losers --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can chose on from rank, name, symbol, price, change, volume.
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_losers --period 24h --urls

image)

cg_yfarms 

usage: cg_yfarms [-t --top] [-s --sortby] [--descend]

Shows Top Yield Farming Pools by Value Locked from https://www.coingecko.com/en/yield-farming Yield farming, also referred to as liquidity mining, is a way to generate rewards with cryptocurrency holdings. In simple terms, it means locking up cryptocurrencies and getting rewards.

  • -t/--top - number of yield farms to display. To display top 10 yield farms: cg_yfarms --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can sort data by rank, name, value_locked, return_year
  • --descend - flag to sort in descending order (lowest first)

image

cg_top_defi 

usage: cg_top_defi [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows Top DeFi Coins by Market Capitalization from https://www.coingecko.com/en/defi DeFi or Decentralized Finance refers to financial services that are built on top of distributed networks with no central intermediaries.

  • -t/--top - number of defi coins to display. To display top 10 defi coins: cg_top_defi --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can sort data by rank, name, symbol, price, change_24h, change_1h, change_7d
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_top_defi --urls.

image

cg_top_dex 

usage: cg_top_dex [-t --top] [-s --sortby] [--descend]

Shows Top Decentralized Exchanges on CoinGecko by Trading Volume from https://www.coingecko.com/en/dex Decentralized exchanges or DEXs are autonomous decentralized applications (DApps) that allow cryptocurrency buyers or sellers to trade without having to give up control over their funds to any intermediary or custodian. Source: coinmarketcap

  • -t/--top - number of Decentralized Exchanges to display. To display top 10 DEX: cg_top_dex --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can sort data by rank, name, volume_24h, n_coins, n_pairs, visits, most_traded, market_share_by_vol most_traded_pairs, market_share_by_volume
  • --descend - flag to sort in descending order (lowest first)

image

cg_top_nft 

usage: cg_top_nft [-t --top] [-s --sortby] [--descend] [-u --urls]

Shows Top NFT Coins by Market Capitalization from https://www.coingecko.com/en/nft NFT (Non-fungible Token) refers to digital assets with unique characteristics. Examples of NFT include crypto artwork, collectibles, game items, financial products, and more.

  • -t/--top - number of NFT to display. To display top 10 NFT Coins: cg_top_nft --top 10 --sortby rank
  • -s/--sortby - sort by given column. You can sort data by rank, name, symbol, price, change_24h, change_1h, change_7d, volume_24h, market_cap
  • --descend - flag to sort in descending order (lowest first)
  • -u/--urls - flag to show urls. Using this flag will add additional column with urls e.g. cg_top_nft --urls.

image

CoinPaprika

cp_coins 

usage: cp_coins [-s --skip] [-t --top] [-l --letter] [-k --key]

Display all available coins in coinpaprika. You can search with pagination mechanism with cp_coins --skip [num] --top [num] or you can just search by letter like cp_coins --letter d --key name --top 10 it will display top 10 matches for coins which name starts with letter d and search will be done in column name

  • -s/--skip: Number of records to skip. Default is 0. There are thousands of coins, so there is mechanism to paginate through them. e.q if you want to see only records from 500-750 you should use cp_coins --skip 500 --top 250 or if you want to see 1200-1880 you should use cp_coins --skip 1200 --top 680.
  • -t/--top: Number of coins to display. E.g cp_coins --top 150
  • -l/--letter: First letters of coin by which you want to search
  • -k/--key: Search key. With this parameter you can specify in which column you would like to search. Choose on from name, id, symbol

cp_search 

usage: cp_search [-q --query] [-c --cat] [-s --sort] [-t --top] [--descend]

Search over CoinPaprika API

  • -q/--query: Phrase for search
  • -c/--cat: Categories to search: currencies|exchanges|icos|people|tags|all. Default: all
  • -t/--top: Number of found records to display.
  • -s/--sort: Sort by given column. You can chose on from category, id, name.
  • --descend: Flag to sort in descending order (lowest first)

image

CoinMarketCap

cmc_top 

cmc_top [-n] [-s --sort SORTBY] [--descend]

This command displays the top n cryptocurrencies from coinmarketcap.com.

  • -n: Number of coins to look at (after sort). Defaults to 10.
  • -s/--sort : Column to sort by. One of {Symbol,CMC_Rank,LastPrice,DayPctChange,MarketCap}. Defaults to sorting by the CMC rank.
  • --descend : Flag to change the sorting order. Sorts in ascending order (since default order is the Rank which starts at 1).
crypto

Binance

bin_coins 

usage: bin_coins [-s --skip] [-t --top] [-l --letter] [-k --key]

Display all available coins on Binance. In Binance terminology symbol means a pair of 2 coins e.g symbol is ETHBTC - it means that baseAsset is ETH and quoteAsset is BTC. You can search with pagination mechanism with bin_coins --skip [num] --top [num] or you can just search by letter like bin_coins --letter d --key symbol --top 10 it will display top 10 matches for coins which symbol starts with letter d and search will be done in column symbol

  • -s/--skip: Number of records to skip. Default is 0. There are thousands of coins, so there is mechanism to paginate through them. e.q if you want to see only records from 500-750 you should use bin_coins --skip 500 --top 250
  • -t/--top: Number of coins to display.
  • -l/--letter: First letters of coin by which you want to search
  • -k/--key: Search key. With this parameter you can specify in which column you would like to search. Choose on from symbol, quoteAsset, baseAsset