coingecko_ruby 0.1.0 → 0.4.0

data/lib/coingecko_ruby/client/indexes.rb

@@ -0,0 +1,88 @@
+module CoingeckoRuby
+  class Client
+    module Indexes
+      # Fetches the list of market indexes listed in CoinGecko.
+      #
+      # @option options [Integer] :per_page (100) sets the number of results to return per page.
+      # @option options [Integer] :page sets the page for results.
+      #
+      # @return [Array<Hash>] each index's id, name, market name, last done, and whether it's a multiasset composite index.
+      #
+      # @example Get all market indexes.
+      #   client.indexes
+      # @example Sample response object
+      #   [
+      #     {"name"=>"CoinFLEX (Futures) DFN",
+      #     "id"=>"DFN",
+      #     "market"=>"CoinFLEX (Futures)",
+      #     "last"=>nil,
+      #     "is_multi_asset_composite"=>nil},
+      #    {"name"=>"Bibox (Futures) LINK",
+      #     "id"=>"LINK",
+      #     "market"=>"Bibox (Futures)",
+      #     "last"=>nil,
+      #     "is_multi_asset_composite"=>nil},
+      #    {"name"=>"CME Bitcoin Futures BTC",
+      #     "id"=>"BTC",
+      #     "market"=>"CME Bitcoin Futures",
+      #     "last"=>nil,
+      #     "is_multi_asset_composite"=>false}
+      #   ]
+      def indexes(**options)
+        get 'indexes', options
+      end
+
+      # @deprecated Use {#indexes} instead
+      def get_indexes(options: {})
+        indexes(**options)
+      end
+
+      # Fetches the ids of market indexes listed in CoinGecko.
+      #
+      # @return [Array<Hash>] each index's id and name.
+      #
+      # @example Get all market index ids and names.
+      #   client.index_ids
+      # @example Sample response object
+      #   [
+      #    {"id"=>"LINK", "name"=>"Bibox (Futures) LINK"},
+      #    {"id"=>"BTC", "name"=>"CME Bitcoin Futures BTC"},
+      #    {"id"=>"XRP", "name"=>"Bibox (Futures) XRP"},
+      #    {"id"=>"ETH", "name"=>"Crypto.com (Futures) ETH"}
+      #   ]
+      def index_ids
+        get 'indexes/list'
+      end
+
+      # @deprecated Use {#index_ids} instead
+      def get_indexes_ids
+        index_ids
+      end
+
+      # Fetches the list of indexes based on the market and index given.
+      #
+      # @param market_id [String] filter results by the market id.
+      # @param coin_id [String] filter indexes from the given market by the index id.
+      #
+      # @return [Array<Hash>] the index's name, market, last done, and whether it's a multiasset composite index.
+      #
+      # @example Get all BTC indexes in the CME Futures market.
+      #   client.indexes_by_market_and_coin(market_id: 'cme_futures', coin_id: 'btc')
+      # @example Sample response object
+      #   {
+      #     "name"=>"CME Bitcoin Futures BTC",
+      #     "market"=>"CME Bitcoin Futures",
+      #     "last"=>nil,
+      #     "is_multi_asset_composite"=>false
+      #   }
+      def indexes_by_market_and_coin(market_id, coin_id, **options)
+        get "indexes/#{market_id}/#{coin_id}", options
+      end
+
+      # @deprecated Use {#indexes_by_market_and_coin} instead
+      def get_indexes_by_market_and_index(market_id:, index_id:, options: {})
+        indexes_by_market_and_index(market_id, index_id, **options)
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/infos.rb

@@ -0,0 +1,174 @@
+module CoingeckoRuby
+  class Client
+    module Infos
+      # Fetches global crypto data from CoinGecko.
+      #
+      # @return [Hash] global crypto data (e.g. market cap, total volume, active ICOs, etc.)
+      #
+      # @example Get global crypto data.
+      #   client.global_crypto_data
+      # @example Sample response object (truncated)
+      #   {
+      #     "data" => {
+      #       "active_cryptocurrencies" => 7361,
+      #       "upcoming_icos" => 0,
+      #       "ongoing_icos" => 50,
+      #       "ended_icos" => 3375,
+      #       "markets" => 616,
+      #       "total_market_cap" => {
+      #         "btc" => 48541739.601360835,
+      #         "eth" => 628896708.615425,
+      #         "ltc" => 7052042789.61238,
+      #         "bch" => 1934433566.5425043
+      #       },
+      #       "total_volume" => {
+      #         "btc" => 6568919.505737251,
+      #         "eth" => 85105558.43783577,
+      #         "ltc" => 954318939.049309,
+      #         "usd" => 286508058915.08606
+      #       }
+      #       "market_cap_percentage" => {
+      #         "btc" => 38.55040456662042,
+      #         "eth" => 18.387297257364622,
+      #       },
+      #       "market_cap_change_percentage_24h_usd" => -3.133283965790086,
+      #       "updated_at" => 1621344957
+      #     }
+      #   }
+      def global_crypto_data
+        get 'global'
+      end
+
+      # @deprecated Use {#global_crypto_data} instead
+      def get_global_crypto_data
+        global_crypto_data
+      end
+
+      # Fetches global crypto data from CoinGecko.
+      #
+      # @return [Hash] global defi data.
+      #
+      # @example Get global defi data.
+      #   client.global_defi_data
+      # @example Sample response object
+      #   {
+      #     "data" => {
+      #       "defi_market_cap" => "125745676087.2760332093360054945",
+      #       "eth_market_cap" => "394420680555.8088822113739591981",
+      #       "defi_to_eth_ratio" =>
+      #       "31.8811062112863892278072770612100063079659263284319798945238447",
+      #       "trading_volume_24h" => "15011166214.23270941006219308344",
+      #       "defi_dominance" =>
+      #       "5.8997291574682455351428477202615510371051549446051010984545824",
+      #       "top_coin_name" => "Uniswap",
+      #       "top_coin_defi_dominance" => 14.449398175884316
+      #     }
+      #   }
+      def global_defi_data
+        get 'global/decentralized_finance_defi'
+      end
+
+      # @deprecated Use {#global_defi_data} instead
+      def get_global_defi_data
+        global_defi_data
+      end
+
+      # Fetches the top 7 coin searches from CoinGecko in the last 24 hours.
+      #
+      # @return [Hash] the ternding searches and its information.
+      #
+      # @example Get trending searches in the last 24 hours.
+      #   client.trending_searches
+      # @example Sample response object (truncated)
+      #   {
+      #     "coins" => [{
+      #         "item" => {
+      #           "id" => "shiba-inu",
+      #           "coin_id" => 11939,
+      #           "name" => "Shiba Inu",
+      #           "symbol" => "SHIB",
+      #           "market_cap_rank" => 24,
+      #           "thumb" =>
+      #           "https://assets.coingecko.com/coins/images/11939/thumb/SHIBLOGO.png?1600752116",
+      #           "small" =>
+      #           "https://assets.coingecko.com/coins/images/11939/small/SHIBLOGO.png?1600752116",
+      #           "large" =>
+      #           "https://assets.coingecko.com/coins/images/11939/large/SHIBLOGO.png?1600752116",
+      #           "slug" => "shiba-inu",
+      #           "price_btc" => 3.637711629799728e-10,
+      #           "score" => 0
+      #         }
+      #       },
+      #     ],
+      #     "exchanges" => []
+      #   }
+      def trending_searches
+        get 'search/trending'
+      end
+
+      # @deprecated Use {#trending_searches} instead
+      def get_trending_searches
+        trending_searches
+      end
+
+      # Fetches coin and/or market status updates.
+      #
+      # @option options [String] :category filter results by the given category. Valid values: general, milestone, partnership, exchange_listing, software_release, fund_movement, new_listings, event
+      # @option options [String] :project_type filter results by the project type. Fetches both coin and market status updates if left blank. Valid values: coin, market
+      # @option options [Integer] :per_page sets the number of results to return per page.
+      # @option options [Integer] :page sets the page for results.
+      #
+      # @return [Hash] the list of status updates and its information.
+      #
+      # @example Get a single status update.
+      #   client.status_updates(per_page: 1)
+      # @example Sample response object
+      #   {
+      #     "status_updates" => [{
+      #       "description" =>
+      #       "📢 Community Call & AMA Invitation 📢\r\n" +
+      #       "\r\n" +
+      #       "Thursday 20th May at 4pm CET (Registration below)\r\n" +
+      #       "\r\n" +
+      #       "During this event, we will be updating our community on the latest news and developments at Fuse, covering:\r\n" +
+      #       "\r\n" +
+      #       "- Fuse Dollar (fUSD)\r\n" +
+      #       "- Fuse Cash\r\n" +
+      #       "- Latest partnerships and integrations.\r\n" +
+      #       "- Binance Smart Chain (BSC) bridge.\r\n" +
+      #       "- DeFi on Fuse.\r\n" +
+      #       "- Featured communities.\r\n" +
+      #       "- What to expect for the rest of Q2 and beyond!\r\n" +
+      #       "\r\n" +
+      #       "Please register 👉 https://bit.ly/3furWZs",
+      #       "category" => "general",
+      #       "created_at" => "2021-05-18T08:29:06.537Z",
+      #       "user" => "Robert Miller",
+      #       "user_title" => "Marcom Director ",
+      #       "pin" => false,
+      #       "project" => {
+      #         "type" => "Coin",
+      #         "id" => "fuse-network-token",
+      #         "name" => "Fuse",
+      #         "symbol" => "fuse",
+      #         "image" => {
+      #           "thumb" =>
+      #           "https://assets.coingecko.com/coins/images/10347/thumb/vUXKHEe.png?1601523640",
+      #           "small" =>
+      #           "https://assets.coingecko.com/coins/images/10347/small/vUXKHEe.png?1601523640",
+      #           "large" =>
+      #           "https://assets.coingecko.com/coins/images/10347/large/vUXKHEe.png?1601523640"
+      #         }
+      #       }
+      #     }]
+      #   }
+      def status_updates(**options)
+        get 'status_updates', options
+      end
+
+      def get_status_updates(options: {})
+        status_updates(**options)
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/prices.rb

@@ -1,26 +1,318 @@
 module CoingeckoRuby
   class Client
     module Prices
-      def get_prices(ids:, vs_currencies: 'usd')
-        get('simple/price', { query: { ids: ids, vs_currencies: vs_currencies } })
+      # Fetches the current price for a coin in the given coin or currency.
+      # @param ids [String, Array] the coin id or array of ids to fetch.
+      # @param currency [String, Array] the currency or array of currencies to display the coin's price. Defaults to 'USD'
+      # @option options [Boolean] :include_market_cap include market cap data.
+      # @option options [Boolean] :include_24hr_vol include 24 hour volume data.
+      # @option options [Boolean] :include_24hr_change include 24 hour price change data.
+      # @option options [Boolean] :include_last_updated_at include last updated at value for the given coin.
+      #
+      # @return [Hash] returns the given coin id and its current price.
+      #
+      # @example Fetch the current price in USD for Bitcoin.
+      #   client.price('bitcoin', currency: 'usd')
+      # @example Sample response object
+      #   {
+      #     "bitcoin" => {
+      #       "usd" => 47931 # current price in given currency
+      #     }
+      #   }
+      # @example Fetch the current price, market cap, 24 hour volume, 24 hour price change and last updated at for Bitcoin.
+      #   client.price('bitcoin', 'usd', include_market_cap: true, include_24hr_vol: true, include_24hr_change: true, include_last_updated_at: true)
+      # @example Sample response object
+      #   {
+      #     "bitcoin" => {
+      #       "usd" => 48217, # current price in given currency
+      #       "usd_market_cap" => 905542853013.7438, # market cap in given currency
+      #       "usd_24h_vol" => 66724791943.1098, # 24 hour volume in given currency
+      #       "usd_24h_change" => -2.813036070702345, # 24 hour price change percentage
+      #       "last_updated_at" => 1621142197 # last updated at UNIX timestamp for the given coin
+      #     }
+      #   }
+      def price(ids, currency: 'usd', **options)
+        ids = ids.join(',') if ids.is_a? Array
+        currency = currency.join(',') if currency.is_a? Array
+        get 'simple/price', { ids: ids, vs_currencies: currency, **options }
       end
 
+      # @see Alias for {#price}
+      def prices(ids, currency: 'usd', **options)
+        price(ids, currency: currency, **options)
+      end
+
+      # @deprecated Use {#price} or {#prices} instead
+      def get_price(id:, currency: 'usd', options: {})
+        price(id, currency, **options)
+      end
+
+      # Fetches historical price data for a coin at a given date.
+      # @param id [String] the coin id to fetch.
+      # @param date [String] the date to fetch the historical price, date given must be in the form of 'DD-MM-YYYY' (e.g: '14-05-2021'). Defaults to today's date.
+      #
+      # @return [Hash] returns the coin's historical price data on the given date.
+      #
+      # @example Fetch Bitcoin's price on 30th December, 2017.
+      #   client.historical_price('bitcoin', date: '30-12-2017')
+      # @example Sample response object (truncated)
+      #   {
+      #     "id": "bitcoin",
+      #     "symbol": "btc",
+      #     "name": "Bitcoin",
+      #     "localization": {
+      #       "en": "Bitcoin",
+      #       "ja": "ビットコイン",
+      #       "id": "Bitcoin"
+      #     },
+      #     "image": {
+      #       "thumb": "https://assets.coingecko.com/coins/images/1/thumb/bitcoin.png?1547033579",
+      #       "small": "https://assets.coingecko.com/coins/images/1/small/bitcoin.png?1547033579"
+      #     },
+      #     "market_data": {
+      #       "current_price": {
+      #         "btc": 1,
+      #         "eth": 18.483094024188404,
+      #         "eur": 11345.8976447824,
+      #         "gbp": 10079.0677868681,
+      #         "usd": 13620.3618741461,
+      #       },
+      #       "market_cap": {
+      #         "btc": 16772375,
+      #         "eth": 310005384.13394696,
+      #         "eur": 190297650009.907,
+      #         "gbp": 169049904571.772,
+      #         "usd": 228445816988.881,
+      #       },
+      #       "total_volume": {
+      #         "btc": 264345.493482963,
+      #         "eth": 4885922.610916088,
+      #         "eur": 2999236911.91719,
+      #         "gbp": 2664356147.96788,
+      #         "usd": 3600481281.03768,
+      #       }
+      #     },
+      #     "community_data": {
+      #       "facebook_likes": null,
+      #       "twitter_followers": 603664,
+      #       "reddit_average_posts_48h": 2.042,
+      #       "reddit_average_comments_48h": 445.896,
+      #       "reddit_subscribers": 612412,
+      #       "reddit_accounts_active_48h": "14074.0"
+      #     },
+      #     "developer_data": {
+      #       "forks": 13660,
+      #       "stars": 23665,
+      #       "subscribers": 2513,
+      #       "total_issues": 3591,
+      #       "closed_issues": 3022,
+      #       "pull_requests_merged": 5038,
+      #       "pull_request_contributors": 450,
+      #       "code_additions_deletions_4_weeks": {
+      #         "additions": null,
+      #         "deletions": null
+      #       },
+      #       "commit_count_4_weeks": 147
+      #     },
+      #     "public_interest_stats": {
+      #       "alexa_rank": 2912,
+      #       "bing_matches": null
+      #     }
+      #   }
+      def historical_price(id, date:, **options)
+        date = Time.now.strftime('%d-%m-%Y') if date.nil?
+
+        get "coins/#{id}/history", { date: date, **options }
+      end
+
+      # @deprecated Use {#historical_price} instead
       def get_historical_price_on_date(id:, date:)
-        get("coins/#{id}/history", { query: { date: date } })
+        historical_price(id, date: date)
+      end
+
+      # Fetches a coin's historical price data in 5 - 10 minutes ranges.
+      # @note Minutely historical data is only available within the last 24 hours.
+      # @param id [String] the coin id to fetch.
+      # @param currency [String] the currency used to display minutely historical price. Defaults to 'USD'
+      #
+      # @return [Hash] returns the coin's minutely historical price data within the last 24 hours.
+      #
+      # @example Fetch Bitcoin's minutely historical price within the last 24 hours.
+      #   client.minutely_historical_price('bitcoin')
+      # @example Sample response object (truncated)
+      #   {
+      #     "prices" => [
+      #       [1621057474114, 49364.605172521166], # [UNIX timestamp for minutely price data, coin price in given currency]
+      #       [1621057731319, 49482.24672699064],
+      #       [1621058047104, 49759.16253913667],
+      #     ],
+      #     "market_caps" => [
+      #       [1621057474114, 923529491095.7441],
+      #       [1621057731319, 923529491095.7441],
+      #       [1621058047104, 925839705121.9677],
+      #     ],
+      #     "total_volumes" => [
+      #       [1621057474114, 55351845301.87241],
+      #       [1621057731319, 55565821585.076706],
+      #       [1621058047104, 57046967935.326035],
+      #     ]
+      #   }
+      def minutely_historical_price(id, currency: 'usd', **options)
+        get "coins/#{id}/market_chart", { vs_currency: currency, days: 1, **options }
       end
 
-      def get_minutely_historical_prices(id:, vs_currency: 'usd')
-        get("coins/#{id}/market_chart", { query: { vs_currency: vs_currency, days: 1 } })
+      # @deprecated Use {#minutely_historical_price} instead
+      def get_minutely_historical_prices(id:, currency: 'usd')
+        minutely_historical_price(id, currency: currency)
+      end
+
+      # Fetches a coin's historical price data in 1 hour ranges.
+      # @note Hourly historical data is only available within the last 90 days.
+      # @param id [String] the coin id to fetch.
+      # @param currency [String] the currency used to display hourly historical price. Defaults to 'USD'
+      # @param days [Integer] the number of days to fetch hourly historical prices (min: 1 day, max: 90 days). Defaults to 7 days
+      #
+      # @return [Hash] returns the coin's hourly historical price data within the number of days given.
+      #
+      # @example Fetch Bitcoin's hourly historical price in USD within the last 7 days.
+      #   client.hourly_historical_price('bitcoin', days: 7)
+      # @example Sample response object (truncated)
+      #   {
+      #     "prices" => [
+      #       [1620540153122, 58533.64354969528], # [UNIX timestamp for minutely price data, coin price in given currency]
+      #       [1620543723872, 58384.26782776662],
+      #       [1620547381049, 58022.030773147424],
+      #     ], "market_caps" => [
+      #       [1620540153122, 1094831531450.288],
+      #       [1620543723872, 1092040480555.5005],
+      #       [1620547381049, 1085268316789.8125],
+      #     ], "total_volumes" => [
+      #       [1620540153122, 71975097904.11748],
+      #       [1620543723872, 72192190625.33702],
+      #       [1620547381049, 72064327648.28767],
+      #     ]
+      #   }
+      def hourly_historical_price(id, currency: 'usd', days: 7, **options)
+        return daily_historical_price(id, currrency: currency, days: days) if days > 90
+
+        get "coins/#{id}/market_chart", { vs_currency: currency, days: days, **options }
       end
 
-      def get_hourly_historical_prices(id:, days:)
-        return get_daily_historical_prices(id: id, days: days) if days > 90
+      # @deprecated Use {#hourly_historical_price} instead
+      def get_hourly_historical_prices(id:, days:, currency: 'usd')
+        hourly_historical_price(id, currency: currency, days: days)
+      end
+
+      # Fetches a coin's historical price data in daily ranges.
+      # @param id [String] the coin id to fetch.
+      # @param days [Integer] the number of days to fetch daily historical prices. Defaults to 7 days.
+      # @param currency [String] the currency used to display daily historical price. Defaults to USD.
+      #
+      # @return [Hash] returns the coin's daily historical price data within the number of days given.
+      #
+      # @example Fetch Bitcoin's daily historical price within the last 14 days.
+      #   client.daily_historical_prices('bitcoin', days: 14)
+      # @example Sample response object (truncated)
+      #   {
+      #     "prices" => [
+      #       [1620000000000, 56600.74528738432], # [UNIX timestamp for minutely price data, coin price in given currency]
+      #       [1620086400000, 57200.30029871162],
+      #       [1620172800000, 53464.37021950372],
+      #     ], "market_caps" => [
+      #       [1620000000000, 1057850321948.5465],
+      #       [1620086400000, 1069571255195.5189],
+      #       [1620172800000, 999775008412.3738],
+      #     ], "total_volumes" => [
+      #       [1620000000000, 39072664393.929405],
+      #       [1620086400000, 54132470274.07509],
+      #       [1620172800000, 71296763919.13268],
+      #     ]
+      #   }
+      def daily_historical_price(id, currency: 'usd', days: 7, **options)
+        get "coins/#{id}/market_chart", { vs_currency: currency, days: days, interval: 'daily', **options }
+      end
+
+      # @deprecated Use {#daily_historical_price} instead
+      def get_daily_historical_prices(id:, days:, currency: 'usd')
+        daily_historical_price(id, currency: currency, days: days)
+      end
+
+      # Fetches a coin's open, high, low, and close (OHLC) data within the number of days given.
+      # @param id [String] the coin id to fetch.
+      # @param days [Integer, String] the number of days to fetch daily historical prices. Valid values: 1/7/14/30/90/180/365/'max'. Defaults to 7 days.
+      # @param currency [String] the currency to display OHLC data. Defaults to 'USD'.
+      #
+      # @return [Array<Array<String, Float>>] returns the coin's OHLC data within the number of days given.
+      #   If the number of days given is between 1-2 days, the OHLC data is returned in 30-minute intervals.
+      #   If the number of days given is between 3-30 days, the OHLC data is returned in 4-hour intervals.
+      #   If the number of days given is more than 30 days, the OHLC data is returned in 4-day intervals.
+      #
+      # @example Fetch Bitcoin's OHLC data within the last 7 days.
+      #   client.ohlc('bitcoin', days: 7)
+      # @example Sample response object (truncated)
+      #   [
+      #     [1620547200000, 58384.27, 58384.27, 58384.27, 58384.27], # [UNIX timestamp for OHLC data, open, high, low, close]
+      #     [1620561600000, 58022.03, 58214.96, 57943.18, 58048.35],
+      #     [1620576000000, 57956.7, 57956.7, 56636.68, 57302.22],
+      #   ]
+      def ohlc(id, currency: 'usd', days: 7, **options)
+        get "coins/#{id}/ohlc", { vs_currency: currency, days: days, **options }
+      end
+
+      # @deprecated Use {#ohlc} instead
+      def get_ohlc(id:, days:, currency: 'usd')
+        ohlc(id, currency: currency, days: days)
+      end
+
+      # Fetches the list of currencies currently supported by CoinGecko's API.
+      #
+      # @return [Array<String>] returns the list of currencies currently supported by CoinGecko's API.
+      #
+      # @example Fetch supported currencies.
+      #   client.supported_currencies
+      # @example Sample response object (truncated)
+      #   [
+      #     "btc",
+      #     "eth",
+      #     "yfi",
+      #     "usd",
+      #     "aud",
+      #     "eur",
+      #     "gbp",
+      #   ]
+      def supported_currencies
+        get 'simple/supported_vs_currencies'
+      end
 
-        get("coins/#{id}/market_chart", { query: { vs_currency: vs_currency, days: days } })
+      # Fetches the exchange rate for a coin or currency in the given coin or currency.
+      # @param from [String] the coin id or currency to be converted.
+      # @param to [String] the coin id or currency to convert against. Defaults to 'USD'.
+      #
+      # @return [Hash] returns the coin's exchange rate against the given coin or currency.
+      #
+      # @example Fetch the exchange rate for BTC-USD.
+      #   client.exchange_rate(from: 'bitcoin', to: 'usd')
+      # @example Sample response object
+      #   {
+      #     "bitcoin" => {
+      #       "usd" => 47931 # current price in given currency
+      #     }
+      #   }
+      # @example Fetch the exchange rate for BTC-ETH.
+      #   client.get_exchange_rate(from: 'bitcoin', to: 'eth')
+      # @example Sample response object
+      #   {
+      #     "bitcoin" => {
+      #       "eth" => 12.71434 # current price in given currency
+      #     }
+      #   }
+      def exchange_rate(from:, to: 'usd')
+        price(from, currency: to)
       end
 
-      def get_daily_historical_prices(id:, days:)
-        get("coins/#{id}/market_chart", { query: { vs_currency: vs_currency, days: days, interval: 'daily' } })
+      # @deprecated Use {#exchange_rate} instead
+      def get_exchange_rate(from:, to: 'usd')
+        exchange_rate(from: from, to: to)
       end
     end
   end