coingecko_ruby 0.1.0 → 0.4.0

data/lib/coingecko_ruby/client/derivatives.rb

@@ -0,0 +1,154 @@
+module CoingeckoRuby
+  class Client
+    module Derivatives
+      # Fetches the list of derivative products listed in CoinGecko.
+      #
+      # @option options [String] :include_tickers ('unexpired') determines whether to display all tickers or only show unexpired tickers. Valid values: all, unexpired
+      #
+      # @return [Array<Hash>] each derivative product's information.
+      #
+      # @example Get all unexpired derivatives.
+      #   client.derivatives(include_tickers: 'unexpired')
+      # @example Sample response object (truncated)
+      #   [
+      #     {
+      #       "market" => "Binance (Futures)",
+      #       "symbol" => "BTCUSDT",
+      #       "index_id" => "BTC",
+      #       "price" => "44575.26",
+      #       "price_percentage_change_24h" => -0.5892545887194689,
+      #       "contract_type" => "perpetual",
+      #       "index" => 44646.70155337,
+      #       "basis" => -0.11242030301843862,
+      #       "spread" => 0.01,
+      #       "funding_rate" => 0.021205,
+      #       "open_interest" => 1822639548.16,
+      #       "volume_24h" => 27179643527.25483,
+      #       "last_traded_at" => 1621341447,
+      #       "expired_at" => nil
+      #     },
+      #     {
+      #       "market" => "Bybit",
+      #       "symbol" => "BTCUSD",
+      #       "index_id" => "BTC",
+      #       "price" => "44817.5",
+      #       "price_percentage_change_24h" => -0.9426664309079656,
+      #       "contract_type" => "perpetual",
+      #       "index" => 44827.57,
+      #       "basis" => 0.022468901656718915,
+      #       "spread" => 0.01,
+      #       "funding_rate" => 0.01,
+      #       "open_interest" => 1664013731.0,
+      #       "volume_24h" => 5725694670.15,
+      #       "last_traded_at" => 1621340931,
+      #       "expired_at" => nil
+      #     },
+      #   ]
+      def derivatives(**options)
+        get 'derivatives', options
+      end
+
+      # @deprecated Use {#derivatives} instead
+      def get_derivatives(options: {})
+        derivatives(**options)
+      end
+
+      # Fetches the list of derivative exchanges listed in CoinGecko.
+      #
+      # @option options [Integer] :per_page sets the number of results to return per page.
+      # @option options [Integer] :page sets the page for results.
+      # @option options [String] :order sets the sort order for results. Valid values: name_asc, name_desc, open_interest_btc_asc, open_interest_btc_desc, trade_volume_24h_btc_asc, trade_volume_24h_btc_desc.
+      #
+      # @return [Array<Hash>] each derivative exchange's information.
+      #
+      # @example Get one derivative exchange.
+      #   client.derivative_exchanges(per_page: 1)
+      # @example Sample response object
+      #   [{
+      #     "name" => "Binance (Futures)",
+      #     "id" => "binance_futures",
+      #     "open_interest_btc" => 237845.78,
+      #     "trade_volume_24h_btc" => "2209372.18",
+      #     "number_of_perpetual_pairs" => 132,
+      #     "number_of_futures_pairs" => 32,
+      #     "image" =>
+      #     "https://assets.coingecko.com/markets/images/466/small/binance_futures.jpg?1568609512",
+      #     "year_established" => 2019,
+      #     "country" => nil,
+      #     "description" => "",
+      #     "url" => "https://www.binance.com/"
+      #   }]
+      def derivative_exchanges(**options)
+        get 'derivatives/exchanges', options
+      end
+
+      # @deprecated Use {#derivative_exchanges} instead
+      def get_derivative_exchanges(options: {})
+        derivative_exchanges(**options)
+      end
+
+      # Fetches data for a specific derivative exchange.
+      #
+      # @param id [String] the id of the derivative exchange.
+      #
+      # @option options [String] :include_tickers determines whether to display all tickers or only show unexpired tickers. Does not return any ticker data if left blank. Valid values: all, unexpired
+      #
+      # @return [Hash] the derivative exchange's information.
+      #
+      # @example Get data for the Binance Futures derivative exchange.
+      #   client.derivative_exchange('binance_futures')
+      # @example Sample response object
+      #   {
+      #     "name" => "Binance (Futures)",
+      #     "open_interest_btc" => 237845.78,
+      #     "trade_volume_24h_btc" => "2226117.02",
+      #     "number_of_perpetual_pairs" => 132,
+      #     "number_of_futures_pairs" => 32,
+      #     "image" =>
+      #     "https://assets.coingecko.com/markets/images/466/small/binance_futures.jpg?1568609512",
+      #     "year_established" => 2019,
+      #     "country" => nil,
+      #     "description" => "",
+      #     "url" => "https://www.binance.com/"
+      #   }
+      def derivative_exchange(id, **options)
+        get "derivatives/exchanges/#{id}", options
+      end
+
+      # @deprecated Use {#derivative_exchange} instead
+      def get_derivative_exchange(id:, options: {})
+        derivative_exchange(id, **options)
+      end
+
+      # Fetches the list ids and names of derivative exchanges listed in CoinGecko.
+      #
+      # @return [Array<Hash>] each derivative exchange's id and name.
+      #
+      # @example Get all unexpired derivatives.
+      #   client.derivative_exchanges_ids_and_names
+      # @example Sample response object (truncated)
+      #   [
+      #     {
+      #       "id" => "binance_futures",
+      #       "name" => "Binance (Futures)"
+      #     },
+      #     {
+      #       "id" => "huobi_dm",
+      #       "name" => "Huobi Futures"
+      #     },
+      #     {
+      #       "id" => "ftx",
+      #       "name" => "FTX (Derivatives)"
+      #     }
+      #   ]
+      def derivative_exchanges_ids_and_names
+        get 'derivatives/exchanges/list'
+      end
+
+      # @deprecated Use {#derivative_exchanges_ids_and_names} instead
+      def get_derivative_exchanges_ids_and_names
+        derivative_exchanges_ids_and_names
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/events.rb

@@ -0,0 +1,84 @@
+module CoingeckoRuby
+  class Client
+    module Events
+      # Fetches the list of events listed in CoinGecko.
+      # @todo CoinGecko API is not returning any list of events. Investigate why this is happening.
+      #
+      # @option options [String] :country_code country code to fetch list of events from.
+      # @option options [String] :type type of event to fetch.
+      # @option options [Integer] :page sets the page for results.
+      # @option options [Boolean] :upcoming_events_only (true) determines whether to fetch upcoming events only or all events.
+      # @option options [String] :from_date fetch events after the specified date. Date must be in the format of yyyy-mm-dd
+      # @option options [String] :to_date fetch events before the specified date. Date must be in the format of yyyy-mm-dd
+      #
+      # @return [Array<Hash>] each finance platform's name, category, url, facts (description), and centralized status.
+      #
+      # @example Get all upcoming events.
+      #   client.events(upcoming_events_only: true) 
+      def events(**options)
+        get 'events', options
+      end
+
+      # @deprecated Use {#events} instead
+      def get_events(options: {})
+        events(**options)
+      end
+
+      # Fetches the valid list of countries to fetch events from.
+      #
+      # @return [Hash] each country's name and code and the total country count.
+      #
+      # @example Get all event countries.
+      #   client.event_countries
+      # @example Sample response object (truncated)
+      #   {
+      #     "data" => [{
+      #         "country" => nil,
+      #         "code" => ""
+      #       },
+      #       {
+      #         "country" => "Malaysia",
+      #         "code" => "MY"
+      #       },
+      #       {
+      #         "country" => "Singapore",
+      #         "code" => "SG"
+      #       },
+      #       {
+      #         "country" => "United States",
+      #         "code" => "US"
+      #       }
+      #     ],
+      #     "count" => 4
+      #   }
+      def event_countries
+        get 'events/countries'
+      end
+
+      # @deprecated Use {#event_countries} instead
+      def get_event_countries
+        event_countries
+      end
+
+      # Fetches the valid list of events to fetch.
+      #
+      # @return [Array<Hash>] the list of event types and total event types count.
+      #
+      # @example Get all event types.
+      #   client.event_types
+      # @example Sample response object
+      #   {
+      #     "data" => ["Event", "Conference", "Meetup"],
+      #     "count" => 3
+      #   }
+      def event_types
+        get 'events/types'
+      end
+
+      # @deprecated Use {#event_types} instead
+      def get_event_types
+        event_types
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/exchanges.rb

@@ -0,0 +1,193 @@
+module CoingeckoRuby
+  class Client
+    module Exchanges
+      # Fetches complete data for every exchange currently supported by the CoinGecko API.
+      #
+      # @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>] returns an array of hashes of detailed exchange data.
+      #
+      # @example Fetch complete exchange data with 1 result per page.
+      #   client.exchanges(per_page: 1)
+      # @example Sample response object
+      #   [{
+      #     "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,
+      #     "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: {})
+        exchanges(**options)
+      end
+
+      # Fetches complete data for a specific exchange.
+      #
+      # @param id [String] the exchange id to fetch.
+      #
+      # @return [Hash] returns detailed data for the given exchange.
+      #
+      # @example Fetch complete exchange data for Binance.
+      #   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.exchange_ids
+      # @example Sample response object
+      #   [{
+      #     "id" => "aave",
+      #     "name" => "Aave"
+      #   }, {
+      #     "id" => "aax",
+      #     "name" => "AAX"
+      #   }, {
+      #     "id" => "aax_futures",
+      #     "name" => "AAX Futures"
+      #   }]
+      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.
+      # @option options [String] :order ('trust_score_desc') sets the sort order for results. Valid values: trust_score_desc', 'trust_score_asc', 'volume_desc.
+      # @option options [Boolean] :depth (false) displays orderbook depth (2%).
+      #
+      # @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.exchange_tickers('binance', coin_ids: 'bitcoin')
+      # @example Sample response object
+      #   {
+      #     "name" => "Binance", "tickers" => [{
+      #       "base" => "BTC",
+      #       "target" => "USDT",
+      #       "market" => {
+      #         "name" => "Binance", "identifier" => "binance", "has_trading_incentive" => false
+      #       },
+      #       "last" => 48890.78,
+      #       "volume" => 86837.96789156958,
+      #       "converted_last" => {
+      #         "btc" => 0.99871776, "eth" => 12.706618, "usd" => 48867
+      #       },
+      #       "converted_volume" => {
+      #         "btc" => 86727, "eth" => 1103417, "usd" => 4243490314
+      #       },
+      #       "trust_score" => "green",
+      #       "bid_ask_spread_percentage" => 0.01002,
+      #       "timestamp" => "2021-05-16T07:37:00+00:00",
+      #       "last_traded_at" => "2021-05-16T07:37:00+00:00",
+      #       "last_fetch_at" => "2021-05-16T07:37:00+00:00",
+      #       "is_anomaly" => false,
+      #       "is_stale" => false,
+      #       "trade_url" => "https://www.binance.com/en/trade/BTC_USDT?ref=37754157",
+      #       "token_info_url" => nil,
+      #       "coin_id" => "bitcoin",
+      #       "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: {})
+        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.exchange_status('binance', per_page: 1)
+      # @example Sample response object
+      #   {
+      #     "status_updates" => [{
+      #       "description" => "Juventus and Paris Saint-Germain Fan Tokens on Binance Launchpool! \r\n\r\nFarm JUV and PSG tokens By Staking BNB, BUSD & CHZ Tokens\r\n\r\nClick here➡️ https://ter.li/JUV-and-PSG-tokens",
+      #       "category" => "general",
+      #       "created_at" => "2020-12-14T11:18:49.085Z",
+      #       "user" => "Darc",
+      #       "user_title" => "Marketing",
+      #       "pin" => false,
+      #       "project" => {
+      #         "type" => "Market", "id" => "binance", "name" => "Binance", "image" => {
+      #           "thumb" => "https://assets.coingecko.com/markets/images/52/thumb/binance.jpg?1519353250", "small" => "https://assets.coingecko.com/markets/images/52/small/binance.jpg?1519353250", "large" => "https://assets.coingecko.com/markets/images/52/large/binance.jpg?1519353250"
+      #         }
+      #       }
+      #     }]
+      #   }
+      def exchange_status(id, **options)
+        get "exchanges/#{id}/status_updates", options
+      end
+
+      # @deprecated Use {#exchange_status} instead
+      def get_exchange_status_updates(id:, 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. 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.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:)
+        exchange_volume(id, days: days)
+      end
+    end
+  end
+end

data/lib/coingecko_ruby/client/finance.rb

@@ -0,0 +1,100 @@
+module CoingeckoRuby
+  class Client
+    module Finance
+      # Fetches the list of finance platforms (e.g. Celsius Network, dYdX) 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 finance platform's name, category, url, facts (description), and centralized status.
+      #
+      # @example Get all finance platforms.
+      #   client.finance_platforms
+      # @example Sample response object (truncated)
+      #   [
+      #     {
+      #       "name"=>"Binance Staking",
+      #       "facts"=>"",
+      #       "category"=>"CeFi Platform",
+      #       "centralized"=>true,
+      #       "website_url"=>"https://www.binance.com/en/staking"
+      #     },
+      #     {
+      #       "name"=>"Celsius Network",
+      #       "facts"=>"",
+      #       "category"=>"CeFi Platform",
+      #       "centralized"=>true,
+      #       "website_url"=>"https://celsius.network/"
+      #     },
+      #     {
+      #       "name"=>"Cobo",
+      #       "facts"=>"",
+      #       "category"=>"CeFi Platform",
+      #       "centralized"=>true,
+      #       "website_url"=>"https://cobo.com/"
+      #     }
+      #   ]
+      def finance_platforms(**options)
+        get 'finance_platforms', options
+      end
+
+      # @deprecated Use {#finance_platforms} instead
+      def get_finance_platforms(options: {})
+        finance_platforms(**options)
+      end
+
+      # Fetches the list of finance products (e.g. Binance Savings, Nexo, Fulcrum) 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.
+      # @option options [Integer] :start_at filter results based on the launch date of the product in UNIX timestamp format.
+      # @option options [Integer] :end_at filter results based on the end date of the product in UNIX timestamp format.
+      #
+      # @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.finance_products
+      # @example Sample response object (truncated)
+      #   [
+      #     {"platform"=>"Binance Savings",
+      #     "identifier"=>"XTZ001",
+      #     "supply_rate_percentage"=>"1.956035",
+      #     "borrow_rate_percentage"=>nil,
+      #     "number_duration"=>nil,
+      #     "length_duration"=>nil,
+      #     "start_at"=>0,
+      #     "end_at"=>0,
+      #     "value_at"=>0,
+      #     "redeem_at"=>0},
+      #    {"platform"=>"Binance Savings",
+      #     "identifier"=>"ZEC001",
+      #     "supply_rate_percentage"=>"0.182865",
+      #     "borrow_rate_percentage"=>nil,
+      #     "number_duration"=>nil,
+      #     "length_duration"=>nil,
+      #     "start_at"=>0,
+      #     "end_at"=>0,
+      #     "value_at"=>0,
+      #     "redeem_at"=>0},
+      #    {"platform"=>"Crypto.com",
+      #     "identifier"=>"BAT",
+      #     "supply_rate_percentage"=>"2.0",
+      #     "borrow_rate_percentage"=>nil,
+      #     "number_duration"=>nil,
+      #     "length_duration"=>nil,
+      #     "start_at"=>0,
+      #     "end_at"=>0,
+      #     "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: {})
+        finance_products(**options)
+      end
+    end
+  end
+end