coingecko_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8201a549684d13164e7be2d24e3b7cd1705a9629a4f667be2a700041ee7cf1c4
-  data.tar.gz: ef4e06fa6e44789534f9e4b4063719ef9b5b2db92fe70ac5bfa9a79cc8a50534
+  metadata.gz: 3af7d5936d0df61051e26280ae616a949ceb0b84b386cc1737e9629a7bed6726
+  data.tar.gz: c914578222edc879982ddc343cbdff081d0f3874e560e36de2514ec91356fb1f
 SHA512:
-  metadata.gz: 57bd9f719a5dfc883a4106cec1325c6bd56ff92dc268abbf64467b1f7f1958bb831da5691c8ad549f5803745878a87264991be1eadaa99dbf82299d1fed439de
-  data.tar.gz: 31b50034e6ff4b7b9f02d7eef2d8f35da2518e185a660187f9b345b477c089858f177b505657cfb9e9de6c87c73971572426a5c84661cd2f2635cf02a8f3c372
+  metadata.gz: 97f15da83fb56076b2c3d9b06a155ca6ed11d89fd8e5dbc424abaf6da5b29c942012440009616db959f14f95090aac67a156f46a9d3ea245a23ef6c0a1194b1b
+  data.tar.gz: 117c31e94c4cc9ffa862e0d94df2d9dac00e15c766969816c3da6da883f8076a271cfcbbf0b45018496063764d19e06179161ea010b32b5acb75995df364e845

data/.gitignore

@@ -10,4 +10,4 @@
 # rspec failure tracking
 .rspec_status
 
-coingecko_client-0.1.0.gem
+coingecko_client-0.1.*.gem

data/Gemfile.lock

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

data/README.md

@@ -1,8 +1,8 @@
 # CoingeckoClient
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/coingecko_client`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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.
 
 ## Installation
 
@@ -22,7 +22,84 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The available methods are:
+
+
+* Check if API is up:
+```
+2.7.0 :026 > CoingeckoClient::Client.ping
+ => {"gecko_says"=>"(V3) To the Moon!"} 
+```
+
+* List coins
+
+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 
+2.7.0 :029 > list.first
+ => {"id"=>"01coin", "symbol"=>"zoc", "name"=>"01coin"} 
+```
+* Supported_vs_currencies<br>
+
+Get list of supported_vs_currencies.
+```
+2.7.0 :002 > list = CoingeckoClient::Client.supported_vs_currencies
+2.7.0 :003 > list.count
+ => 55 
+2.7.0 :004 > list.first
+ => "btc" 
+```
+
+* Current price <br>
+Get the current price of any cryptocurrencies in any other supported currencies that you need.
+```
+CoingeckoClient::Client.price(<coin>,<currency>)
+```
+For example:
+```
+2.7.0 :016 > CoingeckoClient::Client.price('bitcoin','usd')
+ => 9246.4 
+```
+
+* Historical market data
+To get the historical market data(price, market cap and trade volume) of a given coin, you would use:<br>
+<sub><strong>
+Coingecko's note about this API call: Minutely data will be used for duration within 1 day, Hourly data will be used for duration between 1 day and 90 days, Daily data will be used for duration above 90 days.
+    </sub></strong>
+
+```
+CoingeckoClient::Client.coin_history(<coin>,<currency>,<number_of_days>)
+```
+For example:
+```
+CoingeckoClient::Client.coin_history('bitcoin','usd','7')
+ => {"prices"=>[[1593511281310, 9161.947854845832], ..., [1594113061000, 9247.986673179646]], market_caps"=>[[1593511281310, 168752424140.90503], ..., [...,...]], , "total_volumes"=>[[...]]}
+```
+
+* Market data from coins: <br>
+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}] 
+```
+
+* List exchanges <br>
+List all exchanges <br>
+<sub>Default value:: 100</sub>
+```
+2.7.0 :030 > list=CoingeckoClient::Client.list_exchanges
+2.7.0 :031 > list.count
+ => 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} 
+```
+
 
 ## Development
 

data/coingecko_client.gemspec

@@ -8,7 +8,9 @@ Gem::Specification.new do |spec|
 
   
   spec.summary       = 'A simple coingecko API client '
-  spec.description   = 'Simple client for the coingecko API. This is a work in progress and not all API calls are available at this time.'
+  spec.description   = '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 an oficial gem from Coingecko, it is a MIT license pet project! Use at your own discretion!
+  I published it originally with the methods that I needed 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.'
   spec.homepage      = 'https://github.com/Bruck1701/coingecko_client'
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")

data/lib/coingecko_client.rb

@@ -1,19 +1,21 @@
-require "coingecko_client/version"
+require 'coingecko_client/version'
 require 'excon'
 require 'json'
 
 module CoingeckoClient
   class Error < StandardError; end
-    
+
   # This is a simple client to connect to Coingecko
   class Client
 
     def self.ping
+      # Check API server status
       api_call('ping')
     end
-  
 
+    #########   simple API calls #############
     def self.price(coin, currency)
+      # Get the current price of any cryptocurrencies in any other supported currencies that you need.
       coin = coin.downcase
       currency = currency.downcase
       result = api_call("simple/price?ids=#{coin}&vs_currencies=#{currency}")
@@ -22,16 +24,38 @@ module CoingeckoClient
       result[coin][currency]
     end
 
-
     def self.token_price(platform_id='ethereum',address,currency)
       api_call("simple/token_price/#{platform_id}?contract_addresses=#{address}&vs_currencies=#{currency}")
     end
 
+    def self.supported_vs_currencies
+      api_call('simple/supported_vs_currencies')
+    end
 
+    ############### coins API calls ################
     def self.list_coins
-        api_call('coins/list')
+      api_call('coins/list')
+    end
+
+    def self.coins_list
+      list_coins
     end
 
+    def self.coins_market(currency: 'usd',
+                          ids_list: ['bitcoin'],
+                          order: 'market_cap_desc',
+                          per_page: 100,
+                          page: 1,
+                          sparkline: false,
+                          price_change_percentage: '')
+
+      ids = ids_list.join('%2C')
+      request = "coins/markets?vs_currency=#{currency}&ids=#{ids}"
+      request += "&order=#{order}&per_page=#{per_page}&page=#{page}&sparkline=#{sparkline}"
+      request += "&price_change_percentage=#{price_change_percentage}" unless price_change_percentage.empty?
+
+      api_call(request)
+    end
 
     def self.coin_history(coin,currency,days)
       api_call("coins/#{coin.downcase}/market_chart?vs_currency=#{currency.downcase}&days=#{days}")
@@ -46,7 +70,6 @@ module CoingeckoClient
       end
     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.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coingecko_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bruck1701
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -38,8 +38,12 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-description: Simple client for the coingecko API. This is a work in progress and not
-  all API calls are available at this time.
+description: "This is my first gem and the idea was to develop a super simple and
+  lightweight client to connect with Coingecko API. \n  Keep in mind that this is
+  by no means an oficial gem from Coingecko, it is a MIT license pet project! Use
+  at your own discretion!\n  I published it originally with the methods that I needed
+  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."
 email:
 - kummel@gmail.com
 executables: []