coingecko_client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af7d5936d0df61051e26280ae616a949ceb0b84b386cc1737e9629a7bed6726
-  data.tar.gz: c914578222edc879982ddc343cbdff081d0f3874e560e36de2514ec91356fb1f
+  metadata.gz: dc5b73bb70a8666b4f8d402513d43a0c2cc7c2d6dc82bf06fdf937d6fccdb4ef
+  data.tar.gz: 5bf34b95d2f46c46539bda2f5476b394ba17bb2ca3c925011dcf92864c846efa
 SHA512:
-  metadata.gz: 97f15da83fb56076b2c3d9b06a155ca6ed11d89fd8e5dbc424abaf6da5b29c942012440009616db959f14f95090aac67a156f46a9d3ea245a23ef6c0a1194b1b
-  data.tar.gz: 117c31e94c4cc9ffa862e0d94df2d9dac00e15c766969816c3da6da883f8076a271cfcbbf0b45018496063764d19e06179161ea010b32b5acb75995df364e845
+  metadata.gz: 6fe1ff0b904b605494becf943870fb3ed09a5533c69692f223024c57cc98aa1663461d8cacd160be49be46fea99408c48c37f13f835ddd4bcd7c46373c64e3bd
+  data.tar.gz: 8bed48f7acf2a14fdee91cdbb52d41b1f72d2177b8337a4ac9cec7b92b711eb942df4664314ac9a415511ae6b47a79258924aecfff5da450c6dd4b5a51b97bd2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coingecko_client (0.1.1)
+    coingecko_client (0.1.2)
       excon (~> 0.75.0)
       json (~> 2.3)
 

data/README.md

@@ -1,6 +1,6 @@
 # CoingeckoClient
 
-This is my first gem and the idea was to develop a super simple and lightweight client to connect with Coingecko API. 
+This is my first gem and the idea was to develop a super simple and lightweight client to connect with Coingecko API.
 Keep in mind that this is by no means the oficial gem from Coingecko, it is a pet project that I have interest in keeping it working!
 I published it with the methods that I need for another project, but I'll keep on adding more methods to interact with the rest of the API. Any comments, sugestions, Pull Requests, feel free to contact me.
 
@@ -28,7 +28,7 @@ The available methods are:
 * Check if API is up:
 ```
 2.7.0 :026 > CoingeckoClient::Client.ping
- => {"gecko_says"=>"(V3) To the Moon!"} 
+ => {"gecko_says"=>"(V3) To the Moon!"}
 ```
 
 * List coins
@@ -38,9 +38,9 @@ List all supported coins id, name and symbol (no pagination required)
 ```
 2.7.0 :027 > list=CoingeckoClient::Client.coins_list
 2.7.0 :028 > list.count
- => 7631 
+ => 7631
 2.7.0 :029 > list.first
- => {"id"=>"01coin", "symbol"=>"zoc", "name"=>"01coin"} 
+ => {"id"=>"01coin", "symbol"=>"zoc", "name"=>"01coin"}
 ```
 * Supported_vs_currencies<br>
 
@@ -48,9 +48,9 @@ Get list of supported_vs_currencies.
 ```
 2.7.0 :002 > list = CoingeckoClient::Client.supported_vs_currencies
 2.7.0 :003 > list.count
- => 55 
+ => 55
 2.7.0 :004 > list.first
- => "btc" 
+ => "btc"
 ```
 
 * Current price <br>
@@ -61,7 +61,7 @@ CoingeckoClient::Client.price(<coin>,<currency>)
 For example:
 ```
 2.7.0 :016 > CoingeckoClient::Client.price('bitcoin','usd')
- => 9246.4 
+ => 9246.4
 ```
 
 * Historical market data
@@ -84,7 +84,7 @@ Use this to obtain all the coins market data (price, market cap, volume)
 
 ```
 2.7.0 :019 > CoingeckoClient::Client.coins_market(currency: 'usd',ids_list:['maker'], price_change_percentage:'7d' )
-=> [{"id"=>"maker", "symbol"=>"mkr", "name"=>"Maker", "image"=>"https://assets.coingecko.com/coins/images/1364/large/Mark_Maker.png?1585191826", "current_price"=>465.65, "market_cap"=>419598650, "market_cap_rank"=>30, "total_volume"=>11790566, "high_24h"=>487.76, "low_24h"=>464.65, "price_change_24h"=>-3.61639711, "price_change_percentage_24h"=>-0.77064, "market_cap_change_24h"=>-3408068.16243178, "market_cap_change_percentage_24h"=>-0.80568, "circulating_supply"=>902019.8121058022, "total_supply"=>1005576.0, "ath"=>1798.7, "ath_change_percentage"=>-74.14012, "ath_date"=>"2018-01-20T00:00:00.000Z", "atl"=>168.36, "atl_change_percentage"=>176.28269, "atl_date"=>"2020-03-16T20:52:36.527Z", "roi"=>nil, "last_updated"=>"2020-07-07T09:33:19.687Z", "price_change_percentage_7d_in_currency"=>2.802621306390991}] 
+=> [{"id"=>"maker", "symbol"=>"mkr", "name"=>"Maker", "image"=>"https://assets.coingecko.com/coins/images/1364/large/Mark_Maker.png?1585191826", "current_price"=>465.65, "market_cap"=>419598650, "market_cap_rank"=>30, "total_volume"=>11790566, "high_24h"=>487.76, "low_24h"=>464.65, "price_change_24h"=>-3.61639711, "price_change_percentage_24h"=>-0.77064, "market_cap_change_24h"=>-3408068.16243178, "market_cap_change_percentage_24h"=>-0.80568, "circulating_supply"=>902019.8121058022, "total_supply"=>1005576.0, "ath"=>1798.7, "ath_change_percentage"=>-74.14012, "ath_date"=>"2018-01-20T00:00:00.000Z", "atl"=>168.36, "atl_change_percentage"=>176.28269, "atl_date"=>"2020-03-16T20:52:36.527Z", "roi"=>nil, "last_updated"=>"2020-07-07T09:33:19.687Z", "price_change_percentage_7d_in_currency"=>2.802621306390991}]
 ```
 
 * List exchanges <br>
@@ -93,13 +93,51 @@ List all exchanges <br>
 ```
 2.7.0 :030 > list=CoingeckoClient::Client.list_exchanges
 2.7.0 :031 > list.count
- => 100 
+ => 100
 2.7.0 :032 > list.first
  => {"id"=>"binance", "name"=>"Binance", "year_established"=>2017, "country"=>"Cayman Islands", "description"=>"", "url"=>"https://www.binance.com/", "image"
 =>"https://assets.coingecko.com/markets/images/52/small/binance.jpg?1519353250", "has_trading_incentive"=>false, "trust_score"=>10, "trust_score_rank"=>1, "t
-rade_volume_24h_btc"=>202207.8584274921, "trade_volume_24h_btc_normalized"=>202207.8584274921} 
+rade_volume_24h_btc"=>202207.8584274921, "trade_volume_24h_btc_normalized"=>202207.8584274921}
 ```
 
+* Trending coins <br>
+List the Top 7 trending coins
+```
+2.7.0 :005> CoingeckoClient::Client.coins_trending
+=> {"coins"=>[{"item"=>{"id"=>"matic-network", "coin_id"=>4713, "name"=>"Polygon", "symbol"=>"MATIC", "market_cap_rank"=>22, "thumb"=>"https://assets.coingecko.com/coins/images/4713/thumb/matic___polygon.jpg?1612939050", "small"=>"https://assets.coingecko.com/coins/images/4713/small/matic___polygon.jpg?1612939050", "large"=>"https://assets.coingecko.com/coins/images/4713/large/matic___polygon.jpg?1612939050", "slug"=>"polygon", "price_btc"=>2.8814566254115035e-05, "score"=>0}}
+```
+
+* Global data <br>
+Get global data on cryptocurrencies such as total market cap, trading volume and available markets
+```
+2.7.0 :006> CoingeckoClient::Client.global
+=> {"data"=>{"active_cryptocurrencies"=>7228, "upcoming_icos"=>0, "ongoing_icos"=>50, "ended_icos"=>3375, "markets"=>614, "total_market_cap"=>{"btc"=>47150877.60201247, "eth"=>590487432.9774164, "ltc"=>7267533831.311713, "bch"=>1813437832.9322438, "bnb"=>3952875587.545117, "eos"=>212410692785.36523, "xrp"=>1711624698868.2542, "xlm"=>3552898157262.8335}}
+```
+
+* Global Decentralized Finance(DeFi) data <br>
+Get global data on DeFi such as market cap and trading volume
+```
+2.7.0 :007> CoingeckoClient::Client.global_defi
+=> {"data"=>{"defi_market_cap"=>"137457435788.2066091800193351248", "eth_market_cap"=>"471137550162.7690872337739426092", "defi_to_eth_ratio"=>"29.1756485427064075772610878798993912180217281909005711205424453", "trading_volume_24h"=>"17340967982.36497960812229859576", "defi_dominance"=>"5.7334520883902335884692023116692586282802032110498494559675484", "top_coin_name"=>"Uniswap", "top_coin_defi_dominance"=>14.895455912137919}}
+```
+
+* BTC exchange rates <br>
+Get BTC exchange rate value against various currencies including FIAT, gold/silver and other coins
+```
+irb(main):009:0> CoingeckoClient::Client.btc_to_currency
+=> {"rates"=>{"btc"=>{"name"=>"Bitcoin", "unit"=>"BTC", "value"=>1.0, "type"=>"crypto"}, "eth"=>{"name"=>"Ether", "unit"=>"ETH", "value"=>12.405, "type"=>"crypto"}, "ltc"=>{"name"=>"Litecoin", "unit"=>"LTC", "value"=>152.56, "type"=>"crypto"}, "bch"=>{"name"=>"Bitcoin Cash", "unit"=>"BCH", "value"=>37.964, "type"=>"crypto"}, "bnb"=>{"name"=>"Binance Coin", "unit"=>"BNB", "value"=>83.884, "type"=>"crypto"}, "eos"=>{"name"=>"EOS", "unit"=>"EOS", "value"=>4481.84, "type"=>"crypto"}, "xrp"=>{"name"=>"XRP", "unit"=>"XRP", "value"=>36155.406, "type"=>"crypto"}
+```
+
+* Status Updates <br>
+List status updates from exchanges and coins, such as software releases and policy changes <br>
+Pass project_type 'coin' or 'market' to filter, if project_type is left empty, updates from both coins and markets will be returned
+```
+2.7.0 :012> CoingeckoClient::Client.status_updates(category: 'software_release', project_type: 'coin')
+=> {"status_updates"=>[{"description"=>"The DigiByte team is pleased to release DigiByte v7.17.3! This release resolves the underlying Unit Tests and provides a solid foundation for the upcoming version 8 release. No fork / consensus cha
+nges here. Upgrading 100% optional.\r\n\r\nhttps://github.com/DigiByte-Core/digibyte/releases/tag/v7.17.3", "category"=>"software_release", "created_at"=>"2021-05-13T05:48:18.366Z", "user"=>"Murat Akyurt", "user_title"=>"DGBAT Outreach O
+fficer", "pin"=>false, "project"=>{"type"=>"Coin", "id"=>"digibyte", "name"=>"DigiByte", "symbol"=>"dgb", "image"=>{"thumb"=>"https://assets.coingecko.com/coins/images/63/thumb/digibyte.png?1547033717", "small"=>"https://assets.coingecko
+.com/coins/images/63/small/digibyte.png?1547033717", "large"=>"https://assets.coingecko.com/coins/images/63/large/digibyte.png?1547033717"}}}
+```
 
 ## Development
 

data/coingecko_client.gemspec

@@ -3,8 +3,8 @@ require_relative 'lib/coingecko_client/version'
 Gem::Specification.new do |spec|
   spec.name          = "coingecko_client"
   spec.version       = CoingeckoClient::VERSION
-  spec.authors       = ["Bruck1701"]
-  spec.email         = ["kummel@gmail.com"]
+  spec.authors       = ["Bruck1701", "mark-ruddy"]
+  spec.email         = ["kummel@gmail.com","1markruddy@gmail.com"]
 
   
   spec.summary       = 'A simple coingecko API client '

data/lib/coingecko_client.rb

@@ -70,6 +70,37 @@ module CoingeckoClient
       end
     end
 
+    # Returns Top 7 trending coins
+    def self.coins_trending
+      api_call("search/trending")
+    end
+
+    # Get BTC-to-currency (BTC rate against FIAT, Gold, other coins etc)
+    def self.btc_to_currency
+      api_call("exchange_rates")
+    end
+
+    # Get global data of coins (Total market cap, active coins, market cap percentage)
+    def self.global
+      api_call("global")
+    end
+
+    # Get global data for decentralized finance aka defi
+    def self.global_defi
+      api_call("global/decentralized_finance_defi")
+    end
+
+    # Get status updates from coin maintainers and exchanges
+    def self.status_updates(category: 'general',
+                            project_type: '',
+                            per_page: 100,
+                            page: 1)
+      # If project_type empty returns statuses from both coins/markets
+      request = "status_updates/?category=#{category}"
+      request += "&project_type=#{project_type}&per_page=#{per_page}&page=#{page}"
+      api_call(request)
+    end
+
     private_class_method def self.api_call(api_request)
       endpoint_head = 'https://api.coingecko.com/api/v3/'
       url = endpoint_head + api_request

data/lib/coingecko_client/version.rb

@@ -1,3 +1,3 @@
 module CoingeckoClient
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: coingecko_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Bruck1701
+- mark-ruddy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -46,6 +47,7 @@ description: "This is my first gem and the idea was to develop a super simple an
   of the API. Any comments, sugestions, Pull Requests, feel free to contact me."
 email:
 - kummel@gmail.com
+- 1markruddy@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []