coingecko_ruby 0.3.0 → 0.4.2

data/lib/coingecko_ruby/client/exchanges.rb

@@ -9,7 +9,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] returns an array of hashes of detailed exchange data.
       #
       # @example Fetch complete exchange data with 1 result per page.
-      #   client.get_exchanges(options: { per_page: 1 })
+      #   client.exchanges(per_page: 1)
       # @example Sample response object
       #   [{
       #     "id" => "binance",
@@ -25,8 +25,13 @@ module CoingeckoRuby
       #     "trade_volume_24h_btc" => 982949.3975723931,
       #     "trade_volume_24h_btc_normalized" => 982949.3975723931
       #   }]
+      def exchanges(**options)
+        get 'exchanges', **options
+      end
+
+      # @deprecated Use {#exchanges} instead
       def get_exchanges(options: {})
-        get 'exchanges', { options: options }
+        exchanges(**options)
       end
 
       # Fetches complete data for a specific exchange.
@@ -36,17 +41,22 @@ module CoingeckoRuby
       # @return [Hash] returns detailed data for the given exchange.
       #
       # @example Fetch complete exchange data for Binance.
-      #   client.get_exchange_data(id: 'binance')
-      def get_exchange_data(id:)
+      #   client.exchange('binance')
+      def exchange(id)
         get "exchanges/#{id}"
       end
 
+      # @deprecated Use {#exchange} instead
+      def get_exchange_data(id:)
+        exchange(id)
+      end
+
       # Fetches exchange ids for every exchange currently supported by the CoinGecko API.
       #
       # @return [Array<Hash>] returns an array of hashes of the exchange id and name.
       #
       # @example Fetch all exchange ids.
-      #   client.get_exchanges_ids
+      #   client.exchange_ids
       # @example Sample response object
       #   [{
       #     "id" => "aave",
@@ -58,13 +68,19 @@ module CoingeckoRuby
       #     "id" => "aax_futures",
       #     "name" => "AAX Futures"
       #   }]
-      def get_exchanges_ids
+      def exchange_ids
         get 'exchanges/list'
       end
 
+      # @deprecated Use {#exchange_ids} instead
+      def get_exchanges_ids
+        exchange_ids
+      end
+
       # Fetches coin tickers from a specific exchange.
       #
       # @param id [String] the exchange id to fetch.
+      #
       # @option options [String] :coin_ids comma-separated list of tickers to fetch from the given exchange id (e.g. 'bitcoin, eth, litecoin').
       # @option options [String] :include_exchange_logo includes the exchange's logo.
       # @option options [Integer] :page sets the page for results.
@@ -74,7 +90,7 @@ module CoingeckoRuby
       # @return [Hash] the exchange name and tickers as provided or all tickers if coin_ids is not provided.
       #
       # @example Get Bitcoin tickers from Binance.
-      #   client.get_exchange_tickers(id: 'binance', options: { coin_ids: 'bitcoin' })
+      #   client.exchange_tickers('binance', coin_ids: 'bitcoin')
       # @example Sample response object
       #   {
       #     "name" => "Binance", "tickers" => [{
@@ -104,20 +120,26 @@ module CoingeckoRuby
       #       "target_coin_id" => "tether"
       #     }]
       #   }
+      def exchange_tickers(id, **options)
+        get "exchanges/#{id}/tickers", **options
+      end
+
+      # @deprecated Use {#exchange_tickers} instead
       def get_exchange_tickers(id:, options: {})
-        get "exchanges/#{id}/tickers", { options: options }
+        exchange_tickers(id, **options)
       end
 
       # Fetches news,announcments, and updates from a specific exchange.
       #
       # @param id [String] the exchange id to fetch.
+      #
       # @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 [Hash] the status update data for the given exchange.
       #
       # @example Get the last 3 status updates from Binance.
-      #   client.get_exchange_status_updates(id: 'binance', options: { per_page: 1 })
+      #   client.exchange_status('binance', per_page: 1)
       # @example Sample response object
       #   {
       #     "status_updates" => [{
@@ -134,27 +156,37 @@ module CoingeckoRuby
       #       }
       #     }]
       #   }
+      def exchange_status(id, **options)
+        get "exchanges/#{id}/status_updates", **options
+      end
+
+      # @deprecated Use {#exchange_status} instead
       def get_exchange_status_updates(id:, options: {})
-        get "exchanges/#{id}/status_updates", { options: options }
+        exchange_status(id, **options)
       end
 
       # Fetches trade volume data from a specific exchange.
       #
       # @param id [String] the exchange id to fetch.
-      # @param days [Integer] number of days ago to fetch trade volume data.
+      # @param days [Integer] number of days ago to fetch trade volume data. Defaults to 7 days.
       #
       # @return [Array<Array<Float, String>>] the exchange's trade volume data in 10-minute intervals, hourly intervals, or daily intervals depending on the number of days given
       #
       # @example Get Binance's trade volume from a day ago.
-      #   client.get_exchange_volume(id: 'binance', days: 1)
+      #   client.exchange_volume('binance', days: 1)
       # @example Sample response object (truncated)
       #   [
       #     [1620550200000.0, "1005476.2667217359131632087795432176371669876601688256288859094077173967202827700534809705802"], # [UNIX timestamp for exchange trade volume data, trade volume]
       #     [1620553800000.0, "1018442.2775982988468591292487708941265043962519659923872972786095536137127193126138169804088"],
       #     [1620557400000.0, "1042158.4333253484568599192332614201045319574863305612009609211497295171074087677404153278624"]
       #   ]
+      def exchange_volume(id, days: 7, **options)
+        get "exchanges/#{id}/volume_chart", days: days, **options
+      end
+
+      # @deprecated Use {#exchange_volume} instead
       def get_exchange_volume(id:, days:)
-        get "exchanges/#{id}/volume_chart", { days: days }
+        exchange_volume(id, days: days)
       end
     end
   end

data/lib/coingecko_ruby/client/finance.rb

@@ -9,7 +9,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each finance platform's name, category, url, facts (description), and centralized status.
       #
       # @example Get all finance platforms.
-      #   client.get_finance_platforms
+      #   client.finance_platforms
       # @example Sample response object (truncated)
       #   [
       #     {
@@ -34,8 +34,13 @@ module CoingeckoRuby
       #       "website_url"=>"https://cobo.com/"
       #     }
       #   ]
+      def finance_platforms(**options)
+        get 'finance_platforms', **options
+      end
+
+      # @deprecated Use {#finance_platforms} instead
       def get_finance_platforms(options: {})
-        get 'finance_platforms', { options: options }
+        finance_platforms(**options)
       end
 
       # Fetches the list of finance products (e.g. Binance Savings, Nexo, Fulcrum) listed in CoinGecko.
@@ -48,7 +53,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each finance product's platform, identifier, supply and borrow rate percentage, and the product duration data.
       #
       # @example Get all finance products.
-      #   client.get_finance_products
+      #   client.finance_products
       # @example Sample response object (truncated)
       #   [
       #     {"platform"=>"Binance Savings",
@@ -82,8 +87,13 @@ module CoingeckoRuby
       #     "value_at"=>0,
       #     "redeem_at"=>0}
       #   ]
+      def finance_products(**options)
+        get 'finance_products', **options
+      end
+
+      # @deprecated Use {#finance_products} instead
       def get_finance_products(options: {})
-        get 'finance_products', { options: options }
+        finance_products(**options)
       end
     end
   end

data/lib/coingecko_ruby/client/indexes.rb

@@ -9,7 +9,7 @@ module CoingeckoRuby
       # @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.get_indexes
+      #   client.indexes
       # @example Sample response object
       #   [
       #     {"name"=>"CoinFLEX (Futures) DFN",
@@ -28,8 +28,13 @@ module CoingeckoRuby
       #     "last"=>nil,
       #     "is_multi_asset_composite"=>false}
       #   ]
+      def indexes(**options)
+        get 'indexes', **options
+      end
+
+      # @deprecated Use {#indexes} instead
       def get_indexes(options: {})
-        get 'indexes', { options: options }
+        indexes(**options)
       end
 
       # Fetches the ids of market indexes listed in CoinGecko.
@@ -37,7 +42,7 @@ module CoingeckoRuby
       # @return [Array<Hash>] each index's id and name.
       #
       # @example Get all market index ids and names.
-      #   client.get_indexes_ids
+      #   client.index_ids
       # @example Sample response object
       #   [
       #    {"id"=>"LINK", "name"=>"Bibox (Futures) LINK"},
@@ -45,19 +50,24 @@ module CoingeckoRuby
       #    {"id"=>"XRP", "name"=>"Bibox (Futures) XRP"},
       #    {"id"=>"ETH", "name"=>"Crypto.com (Futures) ETH"}
       #   ]
-      def get_indexes_ids
+      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 index_id [String] filter indexes from the given market by the index 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.get_indexes_by_market_and_index(market_id: 'cme_futures', index_id: 'btc')
+      #   client.indexes_by_market_and_coin(market_id: 'cme_futures', coin_id: 'btc')
       # @example Sample response object
       #   {
       #     "name"=>"CME Bitcoin Futures BTC",
@@ -65,8 +75,13 @@ module CoingeckoRuby
       #     "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: {})
-        get "indexes/#{market_id}/#{index_id}", { options: options }
+        indexes_by_market_and_index(market_id, index_id, **options)
       end
     end
   end

data/lib/coingecko_ruby/client/infos.rb

@@ -6,7 +6,7 @@ module CoingeckoRuby
       # @return [Hash] global crypto data (e.g. market cap, total volume, active ICOs, etc.)
       #
       # @example Get global crypto data.
-      #   client.get_global_crypto_data
+      #   client.global_crypto_data
       # @example Sample response object (truncated)
       #   {
       #     "data" => {
@@ -35,16 +35,21 @@ module CoingeckoRuby
       #       "updated_at" => 1621344957
       #     }
       #   }
-      def get_global_crypto_data
+      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.get_global_defi_data
+      #   client.global_defi_data
       # @example Sample response object
       #   {
       #     "data" => {
@@ -59,16 +64,21 @@ module CoingeckoRuby
       #       "top_coin_defi_dominance" => 14.449398175884316
       #     }
       #   }
-      def get_global_defi_data
+      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.get_trending_searches
+      #   client.trending_searches
       # @example Sample response object (truncated)
       #   {
       #     "coins" => [{
@@ -92,10 +102,15 @@ module CoingeckoRuby
       #     ],
       #     "exchanges" => []
       #   }
-      def get_trending_searches
+      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
@@ -106,7 +121,7 @@ module CoingeckoRuby
       # @return [Hash] the list of status updates and its information.
       #
       # @example Get a single status update.
-      #   client.get_status_updates(options: { per_page: 1 })
+      #   client.status_updates(per_page: 1)
       # @example Sample response object
       #   {
       #     "status_updates" => [{
@@ -147,8 +162,12 @@ module CoingeckoRuby
       #       }
       #     }]
       #   }
+      def status_updates(**options)
+        get 'status_updates', **options
+      end
+
       def get_status_updates(options: {})
-        get 'status_updates', { options: options }
+        status_updates(**options)
       end
     end
   end

data/lib/coingecko_ruby/client/prices.rb

@@ -2,8 +2,8 @@ module CoingeckoRuby
   class Client
     module Prices
       # Fetches the current price for a coin in the given coin or currency.
-      # @param id [String] the coin id to fetch.
-      # @param currency [String] the currency to display the coin's price.
+      # @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.
@@ -12,7 +12,7 @@ module CoingeckoRuby
       # @return [Hash] returns the given coin id and its current price.
       #
       # @example Fetch the current price in USD for Bitcoin.
-      #   client.get_price(id: 'bitcoin', currency: 'usd')
+      #   client.price('bitcoin', currency: 'usd')
       # @example Sample response object
       #   {
       #     "bitcoin" => {
@@ -20,7 +20,7 @@ module CoingeckoRuby
       #     }
       #   }
       # @example Fetch the current price, market cap, 24 hour volume, 24 hour price change and last updated at for Bitcoin.
-      #   client.get_price(id: 'bitcoin', currency: 'usd', options: { include_market_cap: true, include_24hr_vol: true, include_24hr_change: true, include_last_updated_at: true })
+      #   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" => {
@@ -31,18 +31,30 @@ module CoingeckoRuby
       #       "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: {})
-        get 'simple/price', { ids: id, vs_currencies: currency, options: 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').
+      # @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.get_historical_price_on_date(id: 'bitcoin', date: '30-12-2017')
+      #   client.historical_price('bitcoin', date: '30-12-2017')
       # @example Sample response object (truncated)
       #   {
       #     "id": "bitcoin",
@@ -107,19 +119,26 @@ module CoingeckoRuby
       #       "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", { 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.
+      # @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.get_minutely_historical_prices(id: 'bitcoin')
+      #   client.minutely_historical_price('bitcoin')
       # @example Sample response object (truncated)
       #   {
       #     "prices" => [
@@ -138,20 +157,25 @@ module CoingeckoRuby
       #       [1621058047104, 57046967935.326035],
       #     ]
       #   }
+      def minutely_historical_price(id, currency: 'usd', **options)
+        get "coins/#{id}/market_chart", vs_currency: currency, days: 1, **options
+      end
+
+      # @deprecated Use {#minutely_historical_price} instead
       def get_minutely_historical_prices(id:, currency: 'usd')
-        get "coins/#{id}/market_chart", { id: id, vs_currency: currency, days: 1 }
+        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 days [Integer] the number of days to fetch hourly historical prices (min: 1 day, max: 90 days)
-      # @param currency [String] the currency used to display hourly historical price.
+      # @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 within the last 7 days.
-      #   client.get_hourly_historical_prices(id: 'bitcoin', days: 7)
+      # @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" => [
@@ -168,21 +192,26 @@ module CoingeckoRuby
       #       [1620547381049, 72064327648.28767],
       #     ]
       #   }
-      def get_hourly_historical_prices(id:, days:, currency: 'usd')
-        return get_daily_historical_prices(id: id, days: days) if days > 90
+      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 }
+        get "coins/#{id}/market_chart", vs_currency: currency, days: days, **options
+      end
+
+      # @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.
-      # @param currency [String] the currency used to display daily historical price.
+      # @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.get_daily_historical_prices(id: 'bitcoin', days: 14)
+      #   client.daily_historical_prices('bitcoin', days: 14)
       # @example Sample response object (truncated)
       #   {
       #     "prices" => [
@@ -199,30 +228,40 @@ module CoingeckoRuby
       #       [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')
-        get "coins/#{id}/market_chart", { vs_currency: currency, days: days, interval: 'daily' }
+        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'
-      # @param currency [String] the currency to display OHLC data.
+      # @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 in USD within the last 7 days.
-      #   client.get_ohlc(id: 'bitcoin', days: 7, currency: 'usd')
+      # @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')
-        get "coins/#{id}/ohlc", { vs_currency: currency, days: days }
+        ohlc(id, currency: currency, days: days)
       end
 
       # Fetches the list of currencies currently supported by CoinGecko's API.
@@ -247,12 +286,12 @@ module CoingeckoRuby
 
       # 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.
+      # @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.get_exchange_rate(from: 'bitcoin', to: 'usd')
+      #   client.exchange_rate(from: 'bitcoin', to: 'usd')
       # @example Sample response object
       #   {
       #     "bitcoin" => {
@@ -267,8 +306,13 @@ module CoingeckoRuby
       #       "eth" => 12.71434 # current price in given currency
       #     }
       #   }
+      def exchange_rate(from:, to: 'usd')
+        price(from, currency: to)
+      end
+
+      # @deprecated Use {#exchange_rate} instead
       def get_exchange_rate(from:, to: 'usd')
-        get_price(id: from, currency: to)
+        exchange_rate(from: from, to: to)
       end
     end
   end