diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4d2110e73d2..517f6f04be2 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -94,7 +94,7 @@ jobs: - name: Lint Code Base uses: docker://avtodev/markdown-lint:v1 with: - args: "./gamestonk_terminal/options/README.md ./*.md ./changelogs/*.md ./gamestonk_terminal/common/**/*.md" + args: "./gamestonk_terminal/options/README.md ./*.md ./changelogs/*.md ./gamestonk_terminal/common/**/*.md ./gamestonk_terminal/cryptocurrency/**/*.md" tests-python: name: Vanilla Python Tests - (${{ matrix.python-version }}, ${{ matrix.os }}) needs: test diff --git a/gamestonk_terminal/cryptocurrency/README.md b/gamestonk_terminal/cryptocurrency/README.md index 69ae66039a8..8883ac3ecee 100644 --- a/gamestonk_terminal/cryptocurrency/README.md +++ b/gamestonk_terminal/cryptocurrency/README.md @@ -1,26 +1,25 @@ # CRYPTOCURRENCY -This menu aims to explore crypto world. You will have access to discovery menu where you can find most popular coins, yield farms, top defi tokens or nfts. -In overview menu you can find overall crypto statistics, latest news, info about exchanges, stable coins, defi and many others. If you will load given coin from source like coinpaprika, coingecko or binance you will have access to due-diligence menu where you can find more coin related information. -You can also go to technical analysis menu, or plot a chart for your coin -The usage of the following commands along with an example will be exploited below. - - -Note that we have added the ability to look at technical analysis in the ta menu. Data loaded from CoinGecko has no candle data, -so indicators that rely on anything other than close will fail with an error. +This menu aims to explore crypto world. You will have access to discovery menu where you can find most popular coins, +yield farms, top defi tokens or nfts. In overview menu you can find overall crypto statistics, latest news, info about +exchanges, stable coins, defi and many others. If you will load given coin from source like coinpaprika, coingecko or +binance you will have access to due-diligence menu where you can find more coin related information. You can also go +to technical analysis menu, or plot a chart for your coin. The usage of the following commands along with an example +will be explained below. +Note that we have added the ability to look at technical analysis in the ta menu. Data loaded from CoinGecko has no +candle data, so indicators that rely on anything other than close will fail with an error. * [load](#load) - * load coin + * load coin * [chart](#chart) - * load coin + * load coin * [find](#find) - * load coin + * load coin * [clear](#clear) - * load coin + * load coin * [finbrain](#finbrain) - * crypto sentiment from 15+ major news headlines for more then 100 coins - + * crypto sentiment from 15+ major news headlines for more then 100 coins [Discovery standalone menu](/gamestonk_terminal/cryptocurrency/discovery/) @@ -32,29 +31,33 @@ so indicators that rely on anything other than close will fail with an error. [Report generation standalone menu](/gamestonk_terminal/cryptocurrency/report/) - ## load -```` +```text usage: load [-c --coin] [--source] -```` +``` -Load a given coin. You can specify source of the data. Available sources are CoinGecko(cg), CoinPaprika(cp), Binance(bin). Based on source which you will use to load a coin different commands will be available in due diligence menu. -By loading a coin you will have access to a lot of statistics on that coin like price data, available markets, exchanges where coin is listed and also open access to technical analysis menu +Load a given coin. You can specify source of the data. Available sources are CoinGecko(cg), CoinPaprika(cp), +Binance(bin). Based on source which you will use to load a coin different commands will be available in due diligence +menu. By loading a coin you will have access to a lot of statistics on that coin like price data, available markets, +exchanges where coin is listed and also open access to technical analysis menu. * -c/--coin: The coin you wish to load. Every data source has different style of coin ids and names. -In CoinGecko and CoinPaprika you can either use symbol or id of the coin, but in Binance only symbol (coin ticker) is available. -* --source: Source of the data which you want to use to load coin. Available sources are: `cp(CoinPaprika), cg(CoinGecko), bin(Binance)`. Default: `cg` - -To load a coin from CoinGecko use: `load -c bitcoin --source cg`. In other case if you want to load coin from CoinPaprika `load -c btc-bitcoin --source cp` (using id) -or using symbol `load -c BTC --source cp`. To load coin from Binance: `load -c BTC --source bin`. -If you not sure about coin symbol or coin id. You can go to discovery menu and try to list all coins with commands: `cg_coins`, `cp_coins`, `bin_coins` -or you can try to use in current menu `find` commands (only available for CoinGecko and CoinPaprika) + In CoinGecko and CoinPaprika you can either use symbol or id of the coin, but in Binance only symbol (coin ticker) is + available. +* --source: Source of the data which you want to use to load coin. Available sources are: + `cp(CoinPaprika), cg(CoinGecko), bin(Binance)`. Default: `cg` +To load a coin from CoinGecko use: `load -c bitcoin --source cg`. In other case if you want to load coin from +CoinPaprika `load -c btc-bitcoin --source cp` (using id) or using symbol `load -c BTC --source cp`. To load coin from +Binance: `load -c BTC --source bin`. +If you not sure about coin symbol or coin id. You can go to discovery menu and try to list all coins with commands: +`cg_coins`, `cp_coins`, `bin_coins` or you can try to use in current menu `find` commands (only available for +CoinGecko and CoinPaprika) ## disc -``` +```text usage: disc ``` @@ -62,81 +65,82 @@ Go to discovery menu. You can find there trending coins, top gainers, losers, co ## ov -``` +```text usage: ov ``` -Go to overview menu. You can find there different crypto statistics, list of exchanges, best stablecoins, defi metrics and others. - +Go to overview menu. You can find there different crypto statistics, list of exchanges, best stablecoins, defi metrics +and others. ## dd -``` +```text usage: dd ``` Go to due-diligence menu for loaded coin. Depends on source of the data for loaded coin different statistics will be available. - ## chart Display chart for loaded coin. Depends from which source you loaded the coin different parameters for chart will be available: +### Chart: CoinGecko and CoinPaprika -##### CoinGecko and CoinPaprika: - -````bash +```bash usage: chart [-d --days] [--vs] -```` +``` You can specify currency vs which you want to show chart and also number of days to get data for. Maximum range for chart is 1 year (365 days). If you use bigger range it will be automatically converted to 365 limit. -By default currency: usd and days: 30. E.g. if you loaded in previous step Bitcoin and you want to see it's price vs USD in last 90 days range use `chart --vs USD --days 90` +By default currency: usd and days: 30. E.g. if you loaded in previous step Bitcoin and you want to see it's price vs +USD in last 90 days range use `chart --vs USD --days 90` * -d/--days: The number of days to look. Maximum 365 days. Default: 30 * --vs: The currency to look against. Default: `USD` -##### Binance +### Chart: Binance ```bash usage: chart [-d --days] [--vs] [-i --interval] [-l --limit] ``` * --vs: The currency to look against. Default: `USDT` -* -i/--interval. Interval for candles. One of [1day,3day,1hour,2hour,4hour,6hour,8hour,12hour,1week,1min,3min,5min,15min,30min,1month]. Defaults to 1day. +* -i/--interval. Interval for candles. One of [1day,3day,1hour,2hour,4hour,6hour,8hour,12hour,1week,1min,3min,5min,15min,30min,1month]. + Defaults to 1day. * -l/--limit. Number of candles to get. Defaults to 100 ## ta Open Technical Analysis menu for loaded coin -##### CoinGecko and CoinPaprika: +### TA: CoinGecko and CoinPaprika -````bash +```bash usage: ta [-d --days] [--vs] -```` +``` You can specify currency vs which you want to show chart and also number of days to get data for. Maximum range for chart is 1 year (365 days). If you use bigger range it will be automatically converted to 365 limit. -By default currency: usd and days: 30. E.g. if you loaded in previous step Bitcoin and you want to see it's price vs USD in last 90 days range use `chart --vs USD --days 90` +By default currency: usd and days: 30. E.g. if you loaded in previous step Bitcoin and you want to see it's price vs +USD in last 90 days range use `chart --vs USD --days 90` * -d/--days: The number of days to look. Maximum 365 days. Default: 30 * --vs: The currency to look against. Default: `USD` -##### Binance +### TA: Binance ```bash usage: ta [-d --days] [--vs] [-i --interval] [-l --limit] ``` * --vs: The currency to look against. Default: `USDT` -* -i/--interval. Interval for candles. One of [1day,3day,1hour,2hour,4hour,6hour,8hour,12hour,1week,1min,3min,5min,15min,30min,1month]. Defaults to 1day. +* -i/--interval. Interval for candles. One of [1day,3day,1hour,2hour,4hour,6hour,8hour,12hour,1week,1min,3min,5min,15min,30min,1month]. + Defaults to 1day. * -l/--limit. Number of candles to get. Defaults to 100 - ## clear -``` +```text usage: clear ``` @@ -144,11 +148,12 @@ Just remove previously loaded coin. ## find -```` +```text usage: find [-c --coin] [-t --top] [-k --key] [--source] -```` +``` -Find similar coin by coin name,symbol or id. If you don't remember exact name or id of the Coin at Coinpaprika, you can use this command to display coins with similar name, symbol or id to your search query. +Find similar coin by coin name,symbol or id. If you don't remember exact name or id of the Coin at Coinpaprika, you can +use this command to display coins with similar name, symbol or id to your search query. Example of usage: coin name is something like `polka`. So you can try: `find -c polka -k name -t 25` It will search for coin that has similar name to polka and display top 25 matches. If you want to search coins in CoinPaprika source then use `--source cp` flag. @@ -160,19 +165,22 @@ If you want to search coins in CoinPaprika source then use `--source cp` flag. ![image](https://user-images.githubusercontent.com/275820/125335645-150b9680-e34d-11eb-8ab4-6d1de1d9ab84.png) - ## finbrain ```bash usage: finbrain [-c --coin] ``` -FinBrain collects the news headlines from 15+ major financial news sources on a daily basis and analyzes them to generate sentiment scores for more than 4500 US stocks. FinBrain Technologies develops deep learning algorithms for financial analysis and prediction, which currently serves traders from more than 150 countries all around the world. [Source: See https://finbrain.tech] +FinBrain collects the news headlines from 15+ major financial news sources on a daily basis and analyzes them to +generate sentiment scores for more than 4500 US stocks. FinBrain Technologies develops deep learning algorithms for +financial analysis and prediction, which currently serves traders from more than 150 countries all around the world. +[Source: See ] Currently all sentiment is gathered for `COIN-USD` pairs. Please use upper case symbols of coins. * -c/--coin - Symbol of the Coin for which you want to analyse sentiment. Currently available coins are: -``` + +```text AAVE, ADA, ADX, AE, ANT, ARDR, ARK, ATOM, BAT, BCCOIN, BCH, BCN, BLOCK, BNB, BNT, BTC, BTCD, BTG, BTM, BTS, CVC, DASH, DCN, DCR, DGB, DGD, DNT, DOGE, DOT, EDG, EOS, ETH, ETP, FAIR, FCT, FUN, GAME, GAS, GBYTE, GNO, GNT, HSR, ICX, IOC, KIN, KMD, KNC, LINK, LKK, LRC, LSK, LTC, MAID, MCAP, MCO, MGO, MKR, MLN, MONA, MTL, NAV, NEBL, NEO, NLC2, NXS, NXT, OMG, PAY, diff --git a/gamestonk_terminal/cryptocurrency/discovery/README.md b/gamestonk_terminal/cryptocurrency/discovery/README.md index dc198d70c7f..234645fe3b6 100644 --- a/gamestonk_terminal/cryptocurrency/discovery/README.md +++ b/gamestonk_terminal/cryptocurrency/discovery/README.md @@ -1,11 +1,12 @@ # DISCOVERY CRYPTO -This menu aims to discover crypto currencies. You can find the most tranding coins, top nfts, best defi tokens and many others. -The usage of the following commands along with an example will be exploited below. +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](#CoinGecko) + * [cg_coins](#cg_coins) - * show coins available on CoinGecko + * show coins available on CoinGecko * [cg_trending](#cg_trending) * show trending coins on CoinGecko * [cg_most_voted](#cg_most_voted) @@ -30,16 +31,19 @@ The usage of the following commands along with an example will be exploited belo * show top Non Fungible Tokens [CoinPaprika](#CoinPaprika) + * [cp_coins](#cp_coins) * show coins available on CoinPaprika * [cp_search](#cp_search) * show search on CoinPaprika [CoinMarketCap](#CoinMarketCap) + * [cmc_top](#cmc_top) * show top coin from coinmarketcap.com [Binance](#Binance) + * [bin_coins](#bin_coins) * show coins available on Binance @@ -47,27 +51,30 @@ The usage of the following commands along with an example will be exploited belo ## cg_coins -```` +```text 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` +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` +* -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` +* -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](https://user-images.githubusercontent.com/275820/123538885-26428980-d737-11eb-9418-e3f80511786d.png) - ## cg_trending -```` +```text usage: cg_trending [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` Shows most trending coins on CoinGecko. @@ -80,9 +87,9 @@ Shows most trending coins on CoinGecko. ## cg_most_voted -```` +```text usage: cg_most_voted [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` Shows most voted coins on CoinGecko. @@ -95,9 +102,9 @@ Shows most voted coins on CoinGecko. ## cg_most_visited -```` +```text usage: cg_most_visited [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` Shows most visited coins on CoinGecko. @@ -106,14 +113,13 @@ Shows most visited coins on CoinGecko. * --descend - flag to sort in descending order (lowest first) * -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_most_visited --top 10 --links` - ![image](https://user-images.githubusercontent.com/275820/123538524-9cde8780-d735-11eb-9827-c02ea8bd5db7.png) ## cg_sentiment -```` +```text usage: cg_sentiment [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` Shows coins with the most positive sentiment on CoinGecko @@ -122,14 +128,13 @@ Shows coins with the most positive sentiment on CoinGecko * --descend - flag to sort in descending order (lowest first) * -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_sentiment --top 10 --links` - ![image](https://user-images.githubusercontent.com/275820/123538553-c5ff1800-d735-11eb-9fef-ef490184c6d8.png) ## cg_recently -```` +```text usage: cg_recently [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` Shows coins which were recently added on CoinGecko @@ -142,28 +147,29 @@ Shows coins which were recently added on CoinGecko ## cg_top_volume -```` +```text 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` +* -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](https://user-images.githubusercontent.com/275820/124305188-0a8b1900-db65-11eb-953f-febc32500ff9.png) - ## cg_gainers -```` +```text usage: cg_gainers [-p --period] [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` 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` +* -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) @@ -173,13 +179,14 @@ Shows largest gainers - coins which gain the most in given period. ## cg_losers -```` +```text usage: cg_losers [-p --period] [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` 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` +* -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) @@ -187,14 +194,13 @@ Shows largest losers - coins which lost the most in given period. ![image](https://user-images.githubusercontent.com/275820/124305327-3ad2b780-db65-11eb-9922-7783b740312c.png)) - ## cg_yfarms -```` +```text usage: cg_yfarms [-t --top] [-s --sortby] [--descend] -```` +``` -Shows Top Yield Farming Pools by Value Locked from https://www.coingecko.com/en/yield-farming +Shows Top Yield Farming Pools by Value Locked from 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. @@ -202,17 +208,17 @@ In simple terms, it means locking up cryptocurrencies and getting rewards. * -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](https://user-images.githubusercontent.com/275820/124305461-6ce41980-db65-11eb-9c82-648f4ff905e8.png) ## cg_top_defi -```` +```text usage: cg_top_defi [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` -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. +Shows Top DeFi Coins by Market Capitalization from +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` @@ -223,62 +229,65 @@ DeFi or Decentralized Finance refers to financial services that are built on top ## cg_top_dex -```` +```text 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 +Shows Top Decentralized Exchanges on CoinGecko by Trading Volume from 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](#https://coinmarketcap.com/alexandria/article/what-are-decentralized-exchanges-dex) +sellers to trade without having to give up control over their funds to any intermediary or custodian. Source: +[coinmarketcap](#https://coinmarketcap.com/alexandria/article/what-are-decentralized-exchanges-dex) * -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` +* -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](https://user-images.githubusercontent.com/275820/124305536-84230700-db65-11eb-82bf-ad2d0878135c.png) ## cg_top_nft -```` +```text usage: cg_top_nft [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` -Shows Top NFT Coins by Market Capitalization from https://www.coingecko.com/en/nft +Shows Top NFT Coins by Market Capitalization from 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` +* -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) * -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_top_nft --links`. - ![image](https://user-images.githubusercontent.com/275820/124305553-8be2ab80-db65-11eb-92a8-86485d2b7ef8.png) - # CoinPaprika ## cp_coins -```` +```text 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` +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`. +* -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` - +* -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 -```` +```text usage: cp_search [-q --query] [-c --cat] [-s --sort] [-t --top] [--descend] -```` +``` Search over CoinPaprika API @@ -290,20 +299,21 @@ Search over CoinPaprika API ![image](https://user-images.githubusercontent.com/275820/125336200-c7435e00-e34d-11eb-965f-16856f4d9913.png) - # CoinMarketCap ## cmc_top -```` +```text 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). +* -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 @@ -311,16 +321,18 @@ This command displays the top n cryptocurrencies from coinmarketcap.com. ## bin_coins -```` +```text 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` +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` +* -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` +* -k/--key: Search key. With this parameter you can specify in which column you would like to search. Choose on from + `symbol, quoteAsset, baseAsset` diff --git a/gamestonk_terminal/cryptocurrency/due_diligence/README.md b/gamestonk_terminal/cryptocurrency/due_diligence/README.md index cb79240e9af..f2c1d0f58a9 100644 --- a/gamestonk_terminal/cryptocurrency/due_diligence/README.md +++ b/gamestonk_terminal/cryptocurrency/due_diligence/README.md @@ -1,9 +1,11 @@ # DUE DILIGENCE -This menu aims to help in due-diligence of a pre-loaded coin, and the usage of the following commands along with an example will be exploited below. -Based on chosen source of data [CoinPaprika, Binance, Coingecko] different commands will be available in menu. +This menu aims to help in due-diligence of a pre-loaded coin, and the usage of the following commands along with an +example will be exploited below. Based on chosen source of data [CoinPaprika, Binance, Coingecko] different commands +will be available in menu. [CoinGecko](#CoinGecko) + * [info](#info) * show coin base information * [market](#market) @@ -24,6 +26,7 @@ Based on chosen source of data [CoinPaprika, Binance, Coingecko] different comma * show developers data for loaded coins [CoinPaprika](#CoinPaprika) + * [basic](#basic) * show coin basic information * [ps](#ps) @@ -38,13 +41,14 @@ Based on chosen source of data [CoinPaprika, Binance, Coingecko] different comma * show events related to loaded coin [Binance](#Binance) + * [book](#book) * show order book * [balance](#book) * show coin balance - ## chart + ```bash usage: chart [--vs] [-d --days] # binance additional parameters [-i --interval] [-l --limit] ``` @@ -57,70 +61,86 @@ for coin loaded with Binance, you can also specify `[-i --interval] [-l --limit] ## info -```` +```text usage: info -```` +``` -Shows basic information about loaded coin like: id, name, symbol, asset_platform, description, contract_address, market_cap_rank, public_interest_score, total_supply, max_supply, price_change_percentage_24h, price_change_percentage_7d, price_change_percentage_30d, current_price_btc, current_price_eth, current_price_usd +Shows basic information about loaded coin like: id, name, symbol, asset_platform, description, contract_address, +market_cap_rank, public_interest_score, total_supply, max_supply, price_change_percentage_24h, +price_change_percentage_7d, price_change_percentage_30d, current_price_btc, current_price_eth, current_price_usd. ![image](https://user-images.githubusercontent.com/275820/123523774-48e88a00-d6c6-11eb-97cf-71529fb209ca.png) ## market -```` +```text usage: market -```` +``` -Market data for loaded coin. There you find metrics like: market_cap_rank, total_supply, max_supply, circulating_supply, price_change_percentage_24h, price_change_percentage_7d, price_change_percentage_30d, price_change_percentage_60d, price_change_percentage_1y, market_cap_change_24h, market_cap_btc, market_cap_eth, market_cap_usd, total_volume_btc, total_volume_eth, total_volume_usd, high_24h_btc, high_24h_eth, high_24h_usd, low_24h_btc, low_24h_eth, low_24h_usd +Market data for loaded coin. There you find metrics like: market_cap_rank, total_supply, max_supply, circulating_supply, +price_change_percentage_24h, price_change_percentage_7d, price_change_percentage_30d, price_change_percentage_60d, +price_change_percentage_1y, market_cap_change_24h, market_cap_btc, market_cap_eth, market_cap_usd, total_volume_btc, +total_volume_eth, total_volume_usd, high_24h_btc, high_24h_eth, high_24h_usd, low_24h_btc, low_24h_eth, low_24h_usd. ![image](https://user-images.githubusercontent.com/275820/123523943-708c2200-d6c7-11eb-97f4-6fb4f7e12c04.png) ## ath -```` +```text usage: ath -```` +``` -All time high data for loaded coin. You can find there most important metrics regarding ath of coin price like: current_price_btc, current_price_eth, current_price_usd, ath_btc, ath_eth, ath_usd, ath_date_btc, ath_date_eth, ath_date_usd, ath_change_percentage_btc, ath_change_percentage_btc, ath_change_percentage_eth, ath_change_percentage_usd +All time high data for loaded coin. You can find there most important metrics regarding ath of coin price like: +current_price_btc, current_price_eth, current_price_usd, ath_btc, ath_eth, ath_usd, ath_date_btc, ath_date_eth, +ath_date_usd, ath_change_percentage_btc, ath_change_percentage_btc, ath_change_percentage_eth, +ath_change_percentage_usd. ![image](https://user-images.githubusercontent.com/275820/123523988-b648ea80-d6c7-11eb-9b08-7d8afecf9231.png) ## atl -```` +```text usage: atl -```` +``` -All time low data for loaded coin. You can find there most important metrics regarding atl of coin price like: current_price_btc, current_price_eth, current_price_usd, atl_btc, atl_eth, atl_usd, atl_date_btc, atl_date_eth, atl_date_usd, atl_change_percentage_btc, atl_change_percentage_btc, atl_change_percentage_eth, atl_change_percentage_usd +All time low data for loaded coin. You can find there most important metrics regarding atl of coin price like: +current_price_btc, current_price_eth, current_price_usd, atl_btc, atl_eth, atl_usd, atl_date_btc, atl_date_eth, +atl_date_usd, atl_change_percentage_btc, atl_change_percentage_btc, atl_change_percentage_eth, +atl_change_percentage_usd. ![image](https://user-images.githubusercontent.com/275820/123523993-c4970680-d6c7-11eb-89ab-3637155e00a9.png) ## score -```` +```text usage: score -```` +``` -In this view you can find different kind of scores for loaded coin. Those scores represents different rankings, sentiment metrics, some user stats and other, like: coingecko_rank, coingecko_score, developer_score, community_score, liquidity_score, sentiment_votes_up_percentage, sentiment_votes_down_percentage, public_interest_score, facebook_likes, twitter_followers, reddit_average_posts_48h, reddit_average_comments_48h, reddit_subscribers, reddit_accounts_active_48h, telegram_channel_user_count, alexa_rank, bing_matches +In this view you can find different kind of scores for loaded coin. Those scores represents different rankings, +sentiment metrics, some user stats and other, like: coingecko_rank, coingecko_score, developer_score, community_score, +liquidity_score, sentiment_votes_up_percentage, sentiment_votes_down_percentage, public_interest_score, facebook_likes, +twitter_followers, reddit_average_posts_48h, reddit_average_comments_48h, reddit_subscribers, +reddit_accounts_active_48h, telegram_channel_user_count, alexa_rank, bing_matches. ![image](https://user-images.githubusercontent.com/275820/123524080-3707e680-d6c8-11eb-96e0-106b7a9c00c2.png) ## dev -```` +```text usage: dev -```` +``` -Developers data for loaded coin. If the development data is available you can see how the code development of given coin is going on. -There are some statistics that shows number of stars, forks, subscribers, pull requests, commits, merges, contributors on github. +Developers data for loaded coin. If the development data is available you can see how the code development of given +coin is going on. There are some statistics that shows number of stars, forks, subscribers, pull requests, commits, +merges, contributors on github. ![image](https://user-images.githubusercontent.com/275820/123524107-60c10d80-d6c8-11eb-8217-cc767f82d7d9.png) ## web -```` +```text usage: web -```` +``` Websites found for given Coin. You can find there urls to homepage, forum, announcement site and others. @@ -128,57 +148,61 @@ Websites found for given Coin. You can find there urls to homepage, forum, annou ## social -```` +```text usage: social -```` +``` -Display social media corresponding to loaded coin. You can find there name of telegram channel, urls to twitter, reddit, bitcointalk, facebook and discord. +Display social media corresponding to loaded coin. You can find there name of telegram channel, urls to twitter, reddit, +bitcointalk, facebook and discord. ![image](https://user-images.githubusercontent.com/275820/123524140-949c3300-d6c8-11eb-9fb7-1d7a3a084c88.png) ## bc -```` +```text usage: bc -```` +``` -Blockchain explorers URLs for loaded coin. Those are sites like etherescan.io or polkascan.io in which you can see all blockchain data e.g. all txs, all tokens, all contracts... +Blockchain explorers URLs for loaded coin. Those are sites like etherescan.io or polkascan.io in which you can see all +blockchain data e.g. all txs, all tokens, all contracts... ![image](https://user-images.githubusercontent.com/275820/123524154-b5fd1f00-d6c8-11eb-9ec0-1fd1803db422.png) - # CoinPaprika ## basic -```` +```text usage: basic -```` - -Shows basic information about loaded coin like: name, symbol, rank, type, description, platform, proof_type, contract, tags, parent +``` +Shows basic information about loaded coin like: name, symbol, rank, type, description, platform, proof_type, contract, +tags, parent. ## ps -```` +```text usage: ps [--vs] -```` +``` Price, supply related data for loaded coin. There you find metrics like: name, symbol, rank, supply, volume, ath, market cap, price change related metrics - -* --vs: The currency to look against. Available options are: `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. Default: USD +* --vs: The currency to look against. Available options are: + `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. + Default: USD ## mkt -```` +```text usage: mkt [--vs] [-t --top] [-s --sort] [--descend] [-l --links] -```` +``` Get all markets found for given coin. -* --vs: The currency to look against. Available options are: `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. Default: USD +* --vs: The currency to look against. Available options are: + `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. + Default: USD * -t/--top - number of markets to display. To display top 10 markets: `mkt --top 10 --sort trust_score` * -s/--sort - sort by given column. You can chose on from `pct_volume_share, exchange, pair, trust_score, volume,price`. * --descend - flag to sort in descending order (lowest first) @@ -186,9 +210,9 @@ Get all markets found for given coin. ## ex -```` +```text usage: ex [-t --top] [-s --sort] [--descend] -```` +``` Get all exchanges found for given coin. @@ -198,9 +222,9 @@ Get all exchanges found for given coin. ## twitter -```` +```text usage: twitter [-t --top] [-s --sort] [--descend] -```` +``` Show last tweets for given coin. @@ -210,24 +234,25 @@ Show last tweets for given coin. ## events -```` +```text usage: events [-t --top] [-s --sort] [--descend] [-l --links] -```` +``` Show information about most important coins events. * -t/--top: Number of events to display. To display top 10 events: `events --top 10 --sort date` * -s/--sort: Sort by given column. You can chose on from `date, date_to, name, description, is_conference`. * --descend: Flag to sort in descending order (lowest first) -* -l/--links: Flag to show urls. Using this flag will add additional column with urls e.g. `events --links`. If you will use this flag url column will be displayed. - +* -l/--links: Flag to show urls. Using this flag will add additional column with urls e.g. `events --links`. If you + will use this flag url column will be displayed. # Binance ## book -```` + +```text usage: book -l/--limit -```` +``` Gets and shows the order book for the given coin/currency. Shows the cumulative amount of orders. @@ -235,10 +260,10 @@ Gets and shows the order book for the given coin/currency. Shows the cumulative ![orderbook](https://user-images.githubusercontent.com/25267873/116886857-84fcf280-ac21-11eb-9803-5baa8bceca05.png) - ## balance -```` + +```text usage: balance -```` +``` Shows the current holding balance in your account. diff --git a/gamestonk_terminal/cryptocurrency/overview/README.md b/gamestonk_terminal/cryptocurrency/overview/README.md index 96fdf1e2de0..dab9f90bcbd 100644 --- a/gamestonk_terminal/cryptocurrency/overview/README.md +++ b/gamestonk_terminal/cryptocurrency/overview/README.md @@ -4,6 +4,7 @@ This menu aims to explore most important crypto statistics, read latest news, fi The usage of the following commands along with an example will be exploited below. [CoinGecko](#CoinGecko) + * [cg_global](#cg_global) * show global crypto market info * [cg_defi](#cg_defi) @@ -34,6 +35,7 @@ The usage of the following commands along with an example will be exploited belo * show eth, btc holdings by public companies [CoinPaprika](#CoinPaprika) + * [cp_global](#cp_global) * show global crypto market info * [cp_info](#cp_info) @@ -49,106 +51,119 @@ The usage of the following commands along with an example will be exploited belo * [cp_contracts](#cp_contracts) * show all smart contracts for given platform - # CoinGecko ## cg_global -```` +```text usage: cg_global -```` +``` -Display global statistics about Crypto Market like: active_cryptocurrencies, upcoming_icos, ongoing_icos, ended_icos, markets, market_cap_change_percentage_24h, eth_market_cap_in_pct, btc_market_cap_in_pct, altcoin_market_cap_in_pct +Display global statistics about Crypto Market like: active_cryptocurrencies, upcoming_icos, ongoing_icos, ended_icos, +markets, market_cap_change_percentage_24h, eth_market_cap_in_pct, btc_market_cap_in_pct, altcoin_market_cap_in_pct. ![image](https://user-images.githubusercontent.com/275820/123538175-d1514400-d733-11eb-9634-09c341f63cb9.png) ## news -```` +```text usage: cg_news [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` -Shows latest news from https://www.coingecko.com/en/news. Display columns: index, title, author, posted columns. You can sort by each of column above, using `--sort` parameter and also do it descending with `--descend` flag. It's also possible to display urls to news with `--links` flag. If you want to display top 75 news, sorted by author use `cg_news -t 75 -s author` if you want to see urls to source of the news use `cg_news -t 75 -l` +Shows latest news from . Display columns: index, title, author, posted columns. +You can sort by each of column above, using `--sort` parameter and also do it descending with `--descend` flag. It is +also possible to display urls to news with `--links` flag. If you want to display top 75 news, sorted by author use +`cg_news -t 75 -s author` if you want to see urls to source of the news use `cg_news -t 75 -l` -* -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` +* -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` * -s/--sortby - sort by given column. You can chose on from `index, title, author, posted` * --descend - flag to sort in descending order (lowest first) * -l/--links - flag to show urls. Using this flag will add additional column with urls and display only `index, url` columns ![image](https://user-images.githubusercontent.com/275820/124304537-1e824b00-db64-11eb-946d-4eb28a37bd18.png) - ## cg_defi -```` +```text usage: cg_defi -```` +``` -Shows global DeFi statistics. DeFi or Decentralized Finance refers to financial services that are built on top of distributed networks with no central intermediaries. Displays metrics like: defi_market_cap, eth_market_cap, defi_to_eth_ratio, trading_volume_24h, defi_dominance, top_coin_name, top_coin_defi_dominance. +Shows global DeFi statistics. DeFi or Decentralized Finance refers to financial services that are built on top of +distributed networks with no central intermediaries. Displays metrics like: defi_market_cap, eth_market_cap, +defi_to_eth_ratio, trading_volume_24h, defi_dominance, top_coin_name, top_coin_defi_dominance. ![image](https://user-images.githubusercontent.com/275820/123538414-188c0480-d735-11eb-8395-f9bd2f1ef96c.png) ## cg_stables -```` +```text usage: cg_stables [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` -Shows stablecoins by market capitalization. Stablecoins are cryptocurrencies that attempt to peg their market value to some external reference -like the U.S. dollar or to a commodity's price such as gold. +Shows stablecoins by market capitalization. Stablecoins are cryptocurrencies that attempt to peg their market value to +some external reference like the U.S. dollar or to a commodity's price such as gold. * -t/--top - number of coins to display. To display top 10 coins: `cg_stables --top 10 --sortby rank` -* -s/--sortby - sort by given column. You can sort data by `rank, name, symbol, price, change_24h, exchanges, market_cap, change_30d` +* -s/--sortby - sort by given column. You can sort data by + `rank, name, symbol, price, change_24h, exchanges, market_cap, change_30d` * --descend - flag to sort in descending order (lowest first) -* -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_stables --links`. If you will use this flag `rank, name, symbol, url` columns will be displayed. +* -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_stables --links`. + If you will use this flag `rank, name, symbol, url` columns will be displayed. ![image](https://user-images.githubusercontent.com/275820/124305427-62298480-db65-11eb-9216-02cf9690c958.png) - ## cg_nft_today -```` +```text usage: cg_nft_today -```` -Get Non-fungible Token of the Day. Everyday on CoinGecko there is chosen new 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. -`cg_nft_today` command you will display: author, description, url, img url. +``` + +Get Non-fungible Token of the Day. Everyday on CoinGecko there is chosen new 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. `cg_nft_today` command you will display: author, description, url, img url. ![image](https://user-images.githubusercontent.com/275820/123539455-2abc7180-d73a-11eb-9b58-160f11d99b44.png) ## cg_nft -```` +```text usage: nft -```` +``` + Get current state of NFTs market. NFT (Non-fungible Token) refers to digital assets with unique characteristics. Examples of NFT include crypto artwork, collectibles, game items, financial products, and more. `cg_nft` will display: NFT Market Cap, 24h Trading Volume, NFT Dominance vs Global market, Theta Network NFT Dominance. ![image](https://user-images.githubusercontent.com/275820/123539514-7838de80-d73a-11eb-8e22-ef3f250d3003.png) - ## cg_exchanges -```` +```text usage: cg_exchanges [-t --top] [-s --sortby] [--descend] [-l --links] -```` +``` + Shows top crypto exchanges base on trust score. -* -t/--top - number of exchanges to display. To display top 10 exchanges by trust_score: `cg_exchanges --top 10 --sortby trust_score --descend` +* -t/--top - number of exchanges to display. To display top 10 exchanges by trust_score: + `cg_exchanges --top 10 --sortby trust_score --descend` * -s/--sortby - sort by given column. You can sort data by `rank, trust_score, id, name, country, established, trade_volume_24h_btc` * --descend - flag to sort in descending order (lowest first) -* -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_exchanges --links`. Using `links` parameter will display only `rank, name, url` columns +* -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_exchanges --links`. + Using `links` parameter will display only `rank, name, url` columns ![image](https://user-images.githubusercontent.com/275820/123539542-98689d80-d73a-11eb-9561-2de524d329d0.png) ## cg_exrates -```` +```text usage: cg_exrates [-t --top] [-s --sortby] [--descend] -```` +``` Shows list of crypto, fiats, commodity exchange rates from CoinGecko -* -t/--top - number of exchanges to display. To display top 10 exchanges by trust_score: `cg_exrates --top 10 --sortby name --descend` + +* -t/--top - number of exchanges to display. To display top 10 exchanges by trust_score: + `cg_exrates --top 10 --sortby name --descend` * -s/--sortby - sort by given column. You can sort by `index,name,unit, value, type` * --descend - flag to sort in descending order (lowest first) @@ -156,24 +171,25 @@ Shows list of crypto, fiats, commodity exchange rates from CoinGecko ## platforms -```` +```text usage: cg_platforms [-t --top] [-s --sortby] [--descend] -```` -Shows Top Crypto Financial Platforms in which you can borrow or lend your crypto e.g. Celsius, Nexo, Crypto.com, Aave and others. +``` + +Shows Top Crypto Financial Platforms in which you can borrow or lend your crypto e.g. Celsius, Nexo, Crypto.com, Aave +and others. * -t/--top - number of crypto platforms to display. To display top 10 platforms: `cg_platforms --top 10 --sortby name` * -s/--sortby - sort by given column. You can sort data by `rank, name, category, centralized` * --descend - flag to sort in descending order (lowest first) - ![image](https://user-images.githubusercontent.com/275820/123539607-e1205680-d73a-11eb-9ab4-b8998ef37731.png) - ## cg_products -```` +```text usage: cg_products [-t --top] [-s --sortby] [--descend] -```` +``` + Shows Top Crypto Financial Products with which you can earn yield, borrow or lend your crypto. * -t/--top - number of crypto products to display. To display top 10 products: `cg_products --top 10 --sortby name` @@ -184,11 +200,13 @@ Shows Top Crypto Financial Products with which you can earn yield, borrow or len ## indexes -```` +```text usage: cg_indexes [-t --top] [-s --sortby] [--descend] -```` +``` + +Shows list of crypto indexes from CoinGecko.Each crypto index is made up of a selection of cryptocurrencies, grouped +together and weighted by market cap. -Shows list of crypto indexes from CoinGecko.Each crypto index is made up of a selection of cryptocurrencies, grouped together and weighted by market cap. * -t/--top - number of crypto indexes to display. To display top 10 indexes: `cg_indexes --top 10 --sortby name` * -s/--sortby - sort by given column. You can sort data by `rank, name, id, market, last, is_multi_asset_composite` * --descend - flag to sort in descending order (lowest first) @@ -197,150 +215,174 @@ Shows list of crypto indexes from CoinGecko.Each crypto index is made up of a se ## cg_derivatives -```` +```text usage: cg_derivatives [-t --top] [-s --sortby] [--descend] -```` -Shows list of crypto derivatives from CoinGecko. Crypto derivatives are secondary contracts or financial tools that derive their value from a primary -underlying asset. In this case, the primary asset would be a cryptocurrency such as Bitcoin. The most popular crypto derivatives are crypto futures, crypto options, and perpetual contracts. -* -t/--top - number of crypto derivatives to display. To display top 10 derivatives: `cg_derivatives --top 10 --sortby symbol` -* -s/--sortby - sort by given column. You can sort by `rank, market, symbol, price, pct_change_24h, contract_type, basis, spread, funding_rate, volume_24h` -* --descend - flag to sort in descending order (lowest first) +``` +Shows list of crypto derivatives from CoinGecko. Crypto derivatives are secondary contracts or financial tools that +derive their value from a primary underlying asset. In this case, the primary asset would be a cryptocurrency such as +Bitcoin. The most popular crypto derivatives are crypto futures, crypto options, and perpetual contracts. + +* -t/--top - number of crypto derivatives to display. To display top 10 derivatives: `cg_derivatives --top 10 --sortby symbol` +* -s/--sortby - sort by given column. You can sort by + `rank, market, symbol, price, pct_change_24h, contract_type, basis, spread, funding_rate, volume_24h` +* --descend - flag to sort in descending order (lowest first) ![image](https://user-images.githubusercontent.com/275820/124305694-b896c300-db65-11eb-9a15-dfd2d1e5832f.png) ## cg_categories -```` +```text usage: cg_categories [-t --top] [-s --sortby] [--descend] [-l --links] -```` -Shows top cryptocurrency categories by market capitalization from https://www.coingecko.com/en/categories +``` + +Shows top cryptocurrency categories by market capitalization from It includes categories like: stablecoins, defi, solana ecosystem, polkadot ecosystem and many others. -* -t/--top - number of crypto categories to display. To display top 10 crypto categories: `cg_categories --top 10 --sortby rank` -* -s/--sortby - sort by given column. You can sort by `rank, name, change_1h, change_24h, change_7d, market_cap, volume_24h, n_of_coins` +* -t/--top - number of crypto categories to display. To display top 10 crypto categories: + `cg_categories --top 10 --sortby rank` +* -s/--sortby - sort by given column. You can sort by + `rank, name, change_1h, change_24h, change_7d, market_cap, volume_24h, n_of_coins` * --descend - flag to sort in descending order (lowest first) -* -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_categories --links`. Using `links` parameter will display only `rank, name, url` columns +* -l/--links - flag to show urls. Using this flag will add additional column with urls e.g. `cg_categories --links`. + Using `links` parameter will display only `rank, name, url` columns ![image](https://user-images.githubusercontent.com/275820/124305739-c51b1b80-db65-11eb-9f35-6dd1fceb731d.png) - ## cg_hold -```` +```text usage: cg_hold [-c --coin] -```` +``` Shows overview of public companies that holds ethereum or bitcoin -Displays most important metrics like: Total Bitcoin/Ethereum Holdings, Total Value (USD), Public Companies Bitcoin/Ethereum Dominance, Companies. +Displays most important metrics like: Total Bitcoin/Ethereum Holdings, Total Value (USD), Public Companies +Bitcoin/Ethereum Dominance, Companies. -* -c/--coin - chose a coin. Only available for ethereum or bitcoin. If you want to see overview of public companies that holds ethereum use `hold --coin ethereum` for bitcoin `hold --coin bitcoin` +* -c/--coin - chose a coin. Only available for ethereum or bitcoin. If you want to see overview of public companies + that holds ethereum use `hold --coin ethereum` for bitcoin `hold --coin bitcoin` ![image](https://user-images.githubusercontent.com/275820/123539842-f77ae200-d73b-11eb-9d6c-feb2fbd98c01.png) - ## cg_companies -```` +```text usage: cg_companies [-c --coin] [- --links] -```` +``` -Shows Ethereum/Bitcoin Holdings by Public Companies. Track publicly traded companies around the world that are buying ethereum as part of corporate treasury +Shows Ethereum/Bitcoin Holdings by Public Companies. Track publicly traded companies around the world that are buying +ethereum as part of corporate treasury -* -c/--coin - chose a coin. Only available for ethereum or bitcoin. List of public companies that holds ethereum `cg_companies --coin ethereum` for bitcoin `cg_companies --coin bitcoin` -* -l/--links - You can use additional flag `--links` to see urls to announcement about buying btc or eth by given company. In this case of usage `links` only columns `rank, company, url` will be displayed +* -c/--coin - chose a coin. Only available for ethereum or bitcoin. List of public companies that holds ethereum + `cg_companies --coin ethereum` for bitcoin `cg_companies --coin bitcoin` +* -l/--links - You can use additional flag `--links` to see urls to announcement about buying btc or eth by given + company. In this case of usage `links` only columns `rank, company, url` will be displayed ![image](https://user-images.githubusercontent.com/275820/124305825-e419ad80-db65-11eb-85b4-35f2e163f3fd.png) - # CoinPaprika ## cp_global -```` +```text usage: cp_global -```` +``` -Show most important global crypto statistics like: market_cap_usd, volume_24h_usd, bitcoin_dominance_percentage, cryptocurrencies_number, -market_cap_ath_value, market_cap_ath_date, volume_24h_ath_value, volume_24h_ath_date, market_cap_change_24h, volume_24h_change_24h, last_updated +Show most important global crypto statistics like: market_cap_usd, volume_24h_usd, bitcoin_dominance_percentage, +cryptocurrencies_number, market_cap_ath_value, market_cap_ath_date, volume_24h_ath_value, volume_24h_ath_date, +market_cap_change_24h, volume_24h_change_24h, last_updated ## cp_info -```` +```text usage: cp_info [-t --top] [-s --sort] [--descend] -```` +``` + Show basic coin information for all coins from CoinPaprika -* --vs: The currency to look against. Available options are: `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. Default: USD +* --vs: The currency to look against. Available options are: + `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. + Default: USD * -t/--top: Number of coins to display. To display top 10 coins: `cp_info --top 10 --sort rank` -* -s/--sort: Sort by given column. You can chose on from `rank, name, symbol, price, volume_24h, circulating_supply, total_supply, max_supply, ath_price,market_cap, beta_value`. +* -s/--sort: Sort by given column. You can chose on from + `rank, name, symbol, price, volume_24h, circulating_supply, total_supply, max_supply, ath_price,market_cap, beta_value`. * --descend: Flag to sort in descending order (lowest first) ## cp_markets -```` +```text usage: cp_markets [--vs] [-t --top] [-s --sort] [--descend] -```` +``` Show market related (price, supply, volume) coin information for all coins on CoinPaprika -* --vs: The currency to look against. Available options are: `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. Default: USD +* --vs: The currency to look against. Available options are: + `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. + Default: USD * -t/--top: Number of coins to display. To display top 10 coins: `cp_markets --top 10 --sort rank` -* -s/--sort: Sort by given column. You can chose on from `rank, name, symbol, price, volume_24h, mcap_change_24h, pct_change_1h, pct_change_24h, ath_price, pct_from_ath`. +* -s/--sort: Sort by given column. You can chose on from + `rank, name, symbol, price, volume_24h, mcap_change_24h, pct_change_1h, pct_change_24h, ath_price, pct_from_ath`. * --descend: Flag to sort in descending order (lowest first) ## cp_exchanges -```` +```text usage: cp_exchanges [--vs] [-t --top] [-s --sort] [--descend] -```` +``` Show all exchanges from CoinPaprika -* --vs: The currency to look against. Available options are: `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. Default: USD +* --vs: The currency to look against. Available options are: + `BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK`. + Default: USD * -t/--top: Number of coins to display. To display top 10 coins: `cp_exchanges --top 10 --sort rank` -* -s/--sort: Sort by given column. You can chose on from `rank, name, currencies, markets, fiats, confidence, volume_24h, volume_7d, volume_30d, sessions_per_month`. +* -s/--sort: Sort by given column. You can chose on from + `rank, name, currencies, markets, fiats, confidence, volume_24h, volume_7d, volume_30d, sessions_per_month`. * --descend: Flag to sort in descending order (lowest first) ## cp_exmarkets -```` +```text usage: cp_exmarkets [-e --exchange] [-t --top] [-s --sort] [--descend] [-l --links] -```` +``` Get all exchange markets found for given exchange * -e/--exchange: Identifier of exchange e.g for Binance Exchange: `binance` * -t/--top: Number of markets to display. To display top 10 markets: `cp_exmarkets --top 10 --sort reported_volume_24h_share` -* -s/--sort: Sort by given column. You can chose on from `pair , base_currency_name, quote_currency_name, category, reported_volume_24h_share, trust_score, market_url`. +* -s/--sort: Sort by given column. You can chose on from + `pair , base_currency_name, quote_currency_name, category, reported_volume_24h_share, trust_score, market_url`. * --descend: Flag to sort in descending order (lowest first) -* -l/--links: Flag to show urls. Using this flag will add additional column with urls e.g. `cp_exmarkets --links`. If you will use this flag url column will be displayed. +* -l/--links: Flag to show urls. Using this flag will add additional column with urls e.g. `cp_exmarkets --links`. + If you will use this flag url column will be displayed. ## cp_platforms -```` +```text usage: cp_platforms -```` +``` List all smart contract platforms like ethereum, solana, cosmos, eos - ## cp_contracts -```` +```text usage: cp_contracts [-p --platform] [-t --top] [-s --sort] [--descend] -```` +``` Gets all contract addresses for given blockchain platform * -p/--platform: smart contract platform id. Available coins: -``` + +```text btc-bitcoin, eos-eos, eth-ethereum, xrp-xrp, bch-bitcoin-cash, xem-nem, neo-neo, xlm-stellar, etc-ethereum-classic, qtum-qtum, zec-zcash, bts-bitshares, waves-waves, nxt-nxt, act-achain, ubq-ubiq, xcp-counterparty, etp-metaverse-etp, burst-burst, omni-omni, trx-tron, bnb-binance-coin, ardr-ardor, ht-huobi-token, blvr-believer, cake-pa ncakeswap, fsxu-flashx-ultra, chik-chickenkebab-finance, jgn-juggernaut7492, crx-cryptex, whirl-whirl-finance, eubi-eubi-token, swam-swapmatic-token, shells-shells ``` -* -t/--top: Number of smart contracts to display. To display 10 smart contracts: `cp_contracts -p eth-ethereum --top 10 --sort index` + +* -t/--top: Number of smart contracts to display. To display 10 smart contracts: + `cp_contracts -p eth-ethereum --top 10 --sort index` * -s/--sort: Sort by given column. You can chose on from `index, id, type, active, address`. * --descend: Flag to sort in descending order (lowest first)