cryptocompare 0.10.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb1da60424846af0f722e8ee3857276a56a54cab
-  data.tar.gz: 607e0325e789895690d4c2e10f12c20201b254cb
+SHA256:
+  metadata.gz: 8343ea1a62ef844e2301dee0c200984d73480863aae94abe937a902bf6236a6c
+  data.tar.gz: 81e74060ce613c4ef405925ac54d58dee38d6f50e34b7b566812545d27a5f78d
 SHA512:
-  metadata.gz: ef0c477aa83c3a8f325a5f74bc858f608a6175cf553f40ded4cf4093288c4138f4e1a25fe5006f71ca817bfc94a86686fc4e0fe71de5ae4e2d351d238ffd7ade
-  data.tar.gz: cde48298626ef54b0dcac8570219f2d60309f38e5e9f517e14646dfd42a8843b6173a3d536a9f5aed33d90b11ab0abb62c4ecbb559ecdfae577bec4c0a5ce573
+  metadata.gz: 05f5da231667c7a777d1070a5dd549103742212bedb6a25161a9c3b8b10d8eee030b306f67518979f462e195259adda2d6cdde72680c522387accfbb010d909e
+  data.tar.gz: 14890afb1de24ddc601ca7d3bcc915f12e2baae3ff6f83b6866dbbad11cc3e0a2b4c3a0251c596736c62632e2bd16e4449ab678432e0cf4b90de346e5ecb5062

data/.travis.yml

@@ -1,8 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.12.5
+  - 2.3.0
+before_install: gem install bundler -v 2.1.4
 addons:
   code_climate:
     repo_token:

data/README.md

@@ -146,42 +146,42 @@ Generate average price for cryptocurrency to fiat currency.
 ```ruby
 Cryptocompare::Price.generate_avg('BTC', 'USD', ['Coinbase', 'Bitfinex'])
 # => {
-#   RAW: {
-#     MARKET: "CUSTOMAGG",
-#     FROMSYMBOL: "BTC",
-#     TOSYMBOL: "USD",
-#     FLAGS: 0,
-#     PRICE: 4137.43,
-#     LASTUPDATE: 1503454563,
-#     LASTVOLUME: 2,
-#     LASTVOLUMETO: 8271.98,
-#     LASTTRADEID: 19656029,
-#     VOLUME24HOUR: 71728.71957884016,
-#     VOLUME24HOURTO: 279374718.3442189,
-#     OPEN24HOUR: 3885.85,
-#     HIGH24HOUR: 4145,
-#     LOW24HOUR: 3583.46,
-#     LASTMARKET: "Coinbase",
-#     CHANGE24HOUR: 251.58000000000038,
-#     CHANGEPCT24HOUR: 6.474259171095137
+#   "RAW" => {
+#     "MARKET" => "CUSTOMAGG",
+#     "FROMSYMBOL" => "BTC",
+#     "TOSYMBOL" => "USD",
+#     "FLAGS" => 0,
+#     "PRICE" => 4137.43,
+#     "LASTUPDATE" => 1503454563,
+#     "LASTVOLUME" => 2,
+#     "LASTVOLUMETO" => 8271.98,
+#     "LASTTRADEID" => 19656029,
+#     "VOLUME24HOUR" => 71728.71957884016,
+#     "VOLUME24HOURTO" => 279374718.3442189,
+#     "OPEN24HOUR" => 3885.85,
+#     "HIGH24HOUR" => 4145,
+#     "LOW24HOUR" => 3583.46,
+#     "LASTMARKET" => "Coinbase",
+#     "CHANGE24HOUR" => 251.58000000000038,
+#     "CHANGEPCT24HOUR" => 6.474259171095137
 #   },
-#   DISPLAY: {
-#     FROMSYMBOL: "Ƀ",
-#     TOSYMBOL: "$",
-#     MARKET: "CUSTOMAGG",
-#     PRICE: "$ 4,137.43",
-#     LASTUPDATE: "Just now",
-#     LASTVOLUME: "Ƀ 2",
-#     LASTVOLUMETO: "$ 8,271.98",
-#     LASTTRADEID: 19656029,
-#     VOLUME24HOUR: "Ƀ 71,728.7",
-#     VOLUME24HOURTO: "$ 279,374,718.3",
-#     OPEN24HOUR: "$ 3,885.85",
-#     HIGH24HOUR: "$ 4,145",
-#     LOW24HOUR: "$ 3,583.46",
-#     LASTMARKET: "Coinbase",
-#     CHANGE24HOUR: "$ 251.58",
-#     CHANGEPCT24HOUR: "6.47"
+#   "DISPLAY" => {
+#     "FROMSYMBOL" => "Ƀ",
+#     "TOSYMBOL" => "$",
+#     "MARKET" => "CUSTOMAGG",
+#     "PRICE" => "$ 4,137.43",
+#     "LASTUPDATE" => "Just now",
+#     "LASTVOLUME" => "Ƀ 2",
+#     "LASTVOLUMETO" => "$ 8,271.98",
+#     "LASTTRADEID" => 19656029,
+#     "VOLUME24HOUR" => "Ƀ 71,728.7",
+#     "VOLUME24HOURTO" => "$ 279,374,718.3",
+#     "OPEN24HOUR" => "$ 3,885.85",
+#     "HIGH24HOUR" => "$ 4,145",
+#     "LOW24HOUR" => "$ 3,583.46",
+#     "LASTMARKET" => "Coinbase",
+#     "CHANGE24HOUR" => "$ 251.58",
+#     "CHANGEPCT24HOUR" => "6.47"
 #   }
 # }
 ```
@@ -226,6 +226,64 @@ Cryptocompare::PriceHistorical.find('ETH', ['BTC', 'USD', 'EUR'], {'ts' => '1452
 # => {"ETH"=>{"BTC"=>0.08006, "USD"=>225.93, "EUR"=>194.24}}
 ```
 
+### CoinList
+
+Get general info for all the coins available on Cryptocompare's API.
+
+**Example:**
+
+```ruby
+Cryptocompare::CoinList.all
+# => {
+#     "Response" => "Success",
+#     "Message" => "Coin list succesfully returned!",
+#     "BaseImageUrl" => "https://www.cryptocompare.com",
+#     "BaseLinkUrl" => "https://www.cryptocompare.com",
+#     "DefaultWatchlist" => {
+#       "CoinIs" => "1182,7605,5038,24854,3807,3808,202330,5324,5031,20131",
+#       "Sponsored" => ""
+#     },
+#     "Data" => {
+#       "BTC" => {
+#         "Id" => "1182",
+#         "Url" => "/coins/btc/overview",
+#         "ImageUrl" => "/media/19633/btc.png",
+#         "Name" => "BTC",
+#         "Symbol" => "BTC",
+#         "CoinName" => "Bitcoin",
+#         "FullName" => "Bitcoin (BTC)",
+#         "Algorithm" => "SHA256",
+#         "ProofType" => "PoW",
+#         "FullyPremined" => "0",
+#         "TotalCoinSupply" => "21000000",
+#         "PreMinedValue" => "N/A",
+#         "TotalCoinsFreeFloat" => "N/A",
+#         "SortOrder" => "1",
+#         "Sponsored" => false
+#       },
+#       "ETH" => {
+#         "Id" => "7605",
+#         "Url" => "/coins/eth/overview",
+#         "ImageUrl" => "/media/20646/eth_logo.png",
+#         "Name" => "ETH",
+#         "Symbol" => "ETH",
+#         "CoinName" => "Ethereum ",
+#         "FullName" => "Ethereum (ETH)",
+#         "Algorithm" => "Ethash",
+#         "ProofType" => "PoW",
+#         "FullyPremined" => "0",
+#         "TotalCoinSupply" => "0",
+#         "PreMinedValue" => "N/A",
+#         "TotalCoinsFreeFloat" => "N/A",
+#         "SortOrder" => "2",
+#         "Sponsored" => false
+#       },
+#       ...
+#     },
+#     "Type" => 100
+#   }
+```
+
 ### CoinSnapshot
 
 Get data for a currency pair. It returns general block explorer information, aggregated data and individual data for each exchange available.
@@ -298,21 +356,21 @@ Find top pairs by trading volume for a given currency.
 ```ruby
 Cryptocompare::TopPairs.find('ETH')
 # => {
-#   Response: "Success",
-#   Data: [
+#   "Response" => "Success",
+#   "Data" => [
 #     {
-#       exchange: "CCCAGG",
-#       fromSymbol: "ETH",
-#       toSymbol: "USD",
-#       volume24h: 1310705.3005027298,
-#       volume24hTo: 288031723.3503975
+#       "exchange" => "CCCAGG",
+#       "fromSymbol" => "ETH",
+#       "toSymbol" => "USD",
+#       "volume24h" => 1310705.3005027298,
+#       "volume24hTo" => 288031723.3503975
 #     },
 #     {
-#       exchange: "CCCAGG",
-#       fromSymbol: "ETH",
-#       toSymbol: "BTC",
-#       volume24h: 978200.2198323006,
-#       volume24hTo: 77883.06190085363
+#       "exchange" => "CCCAGG",
+#       "fromSymbol" => "ETH",
+#       "toSymbol" => "BTC",
+#       "volume24h" => 978200.2198323006,
+#       "volume24hTo" => 77883.06190085363
 #     },
 #     ...
 #   ]
@@ -330,36 +388,36 @@ Find historical data by minute for BTC to USD.
 ```ruby
 Cryptocompare::HistoMinute.find('BTC', 'USD')
 # => {
-#   Response: "Success",
-#   Type: 100,
-#   Aggregated: true,
-#   Data: [
+#   "Response" => "Success",
+#   "Type" => 100,
+#   "Aggregated" => true,
+#   "Data" => [
 #     {
-#       time: 1502259120,
-#       close: 3396.44,
-#       high: 3397.63,
-#       low: 3396.34,
-#       open: 3397.39,
-#       volumefrom: 98.2,
-#       volumeto: 335485
+#       "time" => 1502259120,
+#       "close" => 3396.44,
+#       "high" => 3397.63,
+#       "low" => 3396.34,
+#       "open" => 3397.39,
+#       "volumefrom" => 98.2,
+#       "volumeto" => 335485
 #     },
 #     {
-#       time: 1502259300,
-#       close: 3396.86,
-#       high: 3396.94,
-#       low: 3396.44,
-#       open: 3396.44,
-#       volumefrom: 16.581031,
-#       volumeto: 56637.869999999995
+#       "time" => 1502259300,
+#       "close" => 3396.86,
+#       "high" => 3396.94,
+#       "low" => 3396.44,
+#       "open" => 3396.44,
+#       "volumefrom" => 16.581031,
+#       "volumeto" => 56637.869999999995
 #     },
 #     ...
 #   ],
-#   TimeTo: 1502259360,
-#   TimeFrom: 1502259120,
-#   FirstValueInArray: true,
-#   ConversionType: {
-#     type: "direct",
-#     conversionSymbol: ""
+#   "TimeTo" => 1502259360,
+#   "TimeFrom" => 1502259120,
+#   "FirstValueInArray" => true,
+#   "ConversionType" => {
+#     "type" => "direct",
+#     "conversionSymbol" => ""
 #   }
 # }
 ```
@@ -375,36 +433,36 @@ Find historical data by hour for BTC to USD.
 ```ruby
 Cryptocompare::HistoHour.find('BTC', 'USD')
 # => {
-#   Response: "Success",
-#   Type: 100,
-#   Aggregated: false,
-#     Data: [
+#   "Response" => "Success",
+#   "Type" => 100,
+#   "Aggregated" => false,
+#     "Data" => [
 #     {
-#       time: 1502259120,
-#       close: 3396.44,
-#       high: 3397.63,
-#       low: 3396.34,
-#       open: 3397.39,
-#       volumefrom: 98.2,
-#       volumeto: 335485
+#       "time" => 1502259120,
+#       "close" => 3396.44,
+#       "high" => 3397.63,
+#       "low" => 3396.34,
+#       "open" => 3397.39,
+#       "volumefrom" => 98.2,
+#       "volumeto" => 335485
 #     },
 #     {
-#       time: 1502259300,
-#       close: 3396.86,
-#       high: 3396.94,
-#       low: 3396.44,
-#       open: 3396.44,
-#       volumefrom: 16.581031,
-#       volumeto: 56637.869999999995
+#       "time" => 1502259300,
+#       "close" => 3396.86,
+#       "high" => 3396.94,
+#       "low" => 3396.44,
+#       "open" => 3396.44,
+#       "volumefrom" => 16.581031,
+#       "volumeto" => 56637.869999999995
 #     },
 #     ...
 #   ],
-#   TimeTo: 1503248400,
-#   TimeFrom: 1502643600,
-#   FirstValueInArray: true,
-#   ConversionType: {
-#     type: "direct",
-#     conversionSymbol: ""
+#   "TimeTo" => 1503248400,
+#   "TimeFrom" => 1502643600,
+#   "FirstValueInArray" => true,
+#   "ConversionType" => {
+#     "type" => "direct",
+#     "conversionSymbol" => ""
 #   }
 # }
 ```
@@ -420,97 +478,229 @@ Find historical data by day for BTC to USD.
 ```ruby
 Cryptocompare::HistoDay.find('BTC', 'USD')
 # => {
-#   Response: "Success",
-#   Type: 100,
-#   Aggregated: false,
-#   Data: [
+#   "Response" => "Success",
+#   "Type" => 100,
+#   "Aggregated" => false,
+#   "Data" => [
 #     {
-#       time: 1500854400,
-#       close: 2763.42,
-#       high: 2798.89,
-#       low: 2715.69,
-#       open: 2756.61,
-#       volumefrom: 83009.25,
-#       volumeto: 229047365.02
+#       "time" => 1500854400,
+#       "close" => 2763.42,
+#       "high" => 2798.89,
+#       "low" => 2715.69,
+#       "open" => 2756.61,
+#       "volumefrom" => 83009.25,
+#       "volumeto" => 229047365.02
 #     },
 #     {
-#       time: 1500940800,
-#       close: 2582.58,
-#       high: 2779.08,
-#       low: 2472.62,
-#       open: 2763.42,
-#       volumefrom: 205883.15,
-#       volumeto: 534765380.75
+#       "time" => 1500940800,
+#       "close" => 2582.58,
+#       "high" => 2779.08,
+#       "low" => 2472.62,
+#       "open" => 2763.42,
+#       "volumefrom" => 205883.15,
+#       "volumeto" => 534765380.75
 #     },
 #     ...
 #   ],
-#   TimeTo: 1503446400,
-#   TimeFrom: 1500854400,
-#   FirstValueInArray: true,
-#   ConversionType: {
-#     type: "direct",
-#     conversionSymbol: ""
+#   "TimeTo" => 1503446400,
+#   "TimeFrom" => 1500854400,
+#   "FirstValueInArray" => true,
+#   "ConversionType" => {
+#     "type" => "direct",
+#     "conversionSymbol" => ""
 #   }
 # }
 ```
 
+## News
+Get news articles from the providers that CryptoCompare has integrated with as well as news provider data.
+
+**Example:**
+
+Get news articles from the providers that CryptoCompare has integrated with.
+
+```ruby
+Cryptocompare::News.all
+# => [
+#     {
+#       "id" => "85721",
+#       "guid" => "https://news.bitcoin.com/?p=127153",
+#       "published_on" => 1520834400,
+#       "imageurl" => "https://images.cryptocompare.com/news/bitcoin.com/b9MBw3g640c.jpeg",
+#       "title" => "Study Finds $3B Worth of Faked Cryptocurrency Volumes and Wash Trades",
+#       "url" => "https://news.bitcoin.com/study-finds-3b-worth-of-faked-cryptocurrency-volumes-and-wash-trades/",
+#       "source" => "bitcoin.com",
+#       "body" => "On March 10 a cryptocurrency trader and researcher published a report on how he believes $3 billion worth of cryptocurrency trade volumes, primarily from a couple of exchanges, are concocted. The author of the study, Sylvain Ribes, alleges that the exchange Okcoin has been fabricating up to 93 percent of its trade volumes. Also read: Thailand [&#8      230;]The post Study Finds $3B Worth of Faked Cryptocurrency Volumes and Wash Trades appeared first on Bitcoin News.",
+#       "tags" => "News|95%|altcoin exchange|Binance|Bitcoin|BTC|Coinmarketcap|Fake Trades|GDAX|Huobi|illiquid assets|Kraken|Liquidity|Livecoinwatch|N-Featured|OKcoin|Okex|Poloniex|Sylvain Ribes|trading|Volumes|Wash Trades|Zhao Changpeng",
+#       "categories" => "BTC|Exchange|Trading",
+#       "lang" => "EN",
+#       "source_info" => {
+#         "name" => "Bitcoin.com",
+#         "lang" => "EN",
+#         "img" => "https://images.cryptocompare.com/news/default/bitcoincom.png"
+#       }
+#     },
+#     ...
+# ]
+```
+
+**Example:**
+
+Get all the news providers that CryptoCompare has integrated with.
+
+```ruby
+Cryptocompare::News.providers
+# => [
+#     {
+#       "key" => "cryptocompare",
+#       "name" => "CryptoCompare",
+#       "lang" => "EN",
+#       "img" => "https://images.cryptocompare.com/news/default/cryptocompare.png"
+#     },
+#     {
+#       "key" => "coindesk",
+#       "name" => "CoinDesk",
+#       "lang" => "EN",
+#       "img" => "https://images.cryptocompare.com/news/default/coindesk.png"
+#     },
+#     {
+#       "key" => "bitcoinmagazine",
+#       "name" => "Bitcoin Magazine",
+#       "lang" => "EN",
+#       "img" => "https://images.cryptocompare.com/news/default/bitcoinmagazine.png"
+#     },
+#     {
+#       "key" => "yahoofinance",
+#       "name" => "Yahoo Finance Bitcoin",
+#       "lang" => "EN",
+#       "img" => "https://images.cryptocompare.com/news/default/yahoofinance.png"
+#     },
+#     ...
+# ]
+```
+
+### Exchanges
+Get exchange data, such as cryptocurrencies that each exchange offers, and the supported conversion cryptocurrencies.
+
+**Examples:**
+
+Get info for all exchanges.
+
+```ruby
+Cryptocompare::Exchanges.all
+# => {
+#   "Coinbase" => [
+#      {
+#         "LTC" => [
+#            "BTC",
+#            "USD",
+#            "EUR"
+#         ],
+#         "ETH" => [
+#            "BTC",
+#            "USD",
+#            "EUR"
+#         ],
+#         "BCH" => [
+#            "USD"
+#         ],
+#         "BTC" => [
+#            "USD",
+#            "GBP",
+#            "EUR",
+#            "CAD"
+#         ]
+#      },
+#   ],
+#   ...
+# }
+```
+
 ## Supported Exchanges
 
-* BTC38
-* BTCC
-* BTCE
-* BTCMarkets
-* BTCXIndia
-* BTER
+* Abucoins
+* ANXBTC
+* Binance
 * Bit2C
 * BitBay
+* BitcoinDE
+* Bitfinex
 * bitFlyer
 * bitFlyerFX
+* Bithumb
 * BitMarket
-* BitSquare
-* Bitfinex
 * Bitso
+* BitSquare
 * Bitstamp
 * Bittrex
 * Bleutrade
+* BTC38
+* BTCChina
+* BTCE
+* BTCMarkets
+* btcXchange
+* BTCXIndia
+* BTER
+* BXinth
 * CCEDK
+* CCEX
 * Cexio
-* CoinCheck
+* CHBTC
 * Coinbase
+* CoinCheck
+* CoinExchange
 * Coinfloor
 * Coinone
+* Coinroom
 * Coinse
 * Coinsetter
 * Cryptopia
+* CryptoX
 * Cryptsy
 * EtherDelta
 * EthexIndia
+* Exmo
+* EXX
 * Gatecoin
+* Gateio
 * Gemini
 * HitBTC
 * Huobi
+* HuobiPro
 * itBit
+* Jubi
 * Korbit
 * Kraken
+* Kucoin
 * LakeBTC
 * Liqui
 * LiveCoin
 * LocalBitcoins
 * Luno
+* Lykke
 * MercadoBitcoin
 * MonetaGo
+* MtGox
+* Novaexchange
 * OKCoin
+* OKEX
 * Paymium
 * Poloniex
 * QuadrigaCX
 * Quoine
+* Remitano
 * TheRockTrading
 * Tidex
+* TrustDEX
+* TuxExchange
 * Unocoin
 * Vaultoro
+* ViaBTC
+* WavesDEX
 * Yacuna
 * Yobit
 * Yunbi
+* Zaif
 
 If no exchange option is specified, then the default 'CCCAGG' is used. This is cryptocompare's aggregated data.