coincap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 400102f77c2de8996aed21a75f3dd351998cceb7fe88130814474dce51ddef33
+  data.tar.gz: d1cf37117aeb04e4d956fdbd0c4de56d9dc93537e3672e0ca2016ffeedb370d4
+SHA512:
+  metadata.gz: 57971399dfeb1d52affcb456202ced30853b1d21f2adc6812fc6a68105833c4445f8c7d1c1848f1930befe1d914ab42000da101204e034b9fe84e42cf385805f
+  data.tar.gz: 340c5c6cbaeacd4990955e51faed298b93ebbbffc80cb4944887cc61bf68d1a7219fdf3fd34eaef5affd17be3867216e8b7ebe0d8ab24f1861069434917232dc

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem 'json'
+gem 'net-http'
+gem 'openssl'
+gem 'uri'
+
+group :test do
+  gem 'minitest'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    coincap (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (2.6.3)
+    minitest (5.18.0)
+    net-http (0.3.2)
+      uri
+    openssl (3.1.0)
+    rake (13.0.6)
+    uri (0.12.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  coincap!
+  json
+  minitest
+  net-http
+  openssl
+  rake
+  uri
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,214 @@
+# coincap
+CoinCap is a useful tool for real-time pricing and market activity for over 1,000 cryptocurrencies. By collecting exchange data from thousands of markets, we are able to offer transparent and accurate data on asset price and availability.
+
+If you want to add 'api key' or change 'accept encoding', just call the 'configure' method.
+
+No API Key: 200 requests per minute
+API Key: 500 requests per minute
+
+Generate API KEY [here](https://coincap.io/api-key).
+
+```Ruby
+Coincap.configure do |config|
+  config.api_key = 'XXXXXXXXXXXXXXXXXXXXX'
+  config.accept_encoding = 'deflate' # Default gzip
+end
+```
+
+Detailed information [here](https://docs.coincap.io/).
+
+## Assets Price
+```Ruby
+data = Coincap::AssetsPrice.cryptocurrencies
+```
+```JSON
+    {
+        "data": [
+            {
+             "id": "bitcoin",
+             "rank": "1",
+             "symbol": "BTC",
+             "name": "Bitcoin",
+             "supply": "17193925.0000000000000000",
+             "maxSupply": "21000000.0000000000000000",
+             "marketCapUsd": "119150835874.4699281625807300",
+             "volumeUsd24Hr": "2927959461.1750323310959460",
+             "priceUsd": "6929.8217756835584756",
+             "changePercent24Hr": "-0.8101417214350335",
+             "vwap24Hr": "7175.0663247679233209"
+            },
+         ...
+        ],
+      "timestamp": 1533581088278
+    }
+```
+
+```Ruby
+data = Coincap::AssetsPrice.cryptocurrency('bitcoin')
+```
+```JSON
+      {
+        "data": {
+          "id": "bitcoin",
+          "rank": "1",
+          "symbol": "BTC",
+          "name": "Bitcoin",
+          "supply": "17193925.0000000000000000",
+          "maxSupply": "21000000.0000000000000000",
+          "marketCapUsd": "119179791817.6740161068269075",
+          "volumeUsd24Hr": "2928356777.6066665425687196",
+          "priceUsd": "6931.5058555666618359",
+          "changePercent24Hr": "-0.8101417214350335",
+          "vwap24Hr": "7175.0663247679233209"
+        },
+        "timestamp": 1533581098863
+      }
+```
+
+```Ruby
+data = Coincap::AssetsPrice.cryptocurrency_history('bitcoin', :one_minute)
+```
+```JSON
+      {
+        "data": [
+         {
+            "priceUsd": "6379.3997635993342453",
+            "time": 1530403200000
+          },
+        ...
+        ],
+        "timestamp": 1533581103627
+      }
+```
+
+```Ruby
+data = Coincap::AssetsPrice.cryptocurrency_with_markets('bitcoin')
+```
+```JSON
+      {
+        "data": [
+          {
+            "exchangeId": "Binance",
+            "baseId": "bitcoin",
+            "quoteId": "tether",
+            "baseSymbol": "BTC",
+            "quoteSymbol": "USDT",
+            "volumeUsd24Hr": "277775213.1923032624064566",
+            "priceUsd": "6263.8645034633024446",
+            "volumePercent": "7.4239157877678087"
+          },
+          ...
+        ],
+        "timestamp": 1539289444052
+      }
+```
+
+## Rates
+```Ruby
+data = Coincap::Rates.list
+```
+```JSON
+      {
+        "data": [
+          {
+            "id": "barbadian-dollar",
+            "symbol": "BBD",
+            "currencySymbol": "$",
+            "type": "fiat",
+            "rateUsd": "0.5000000000000000"
+          },
+        ...
+        ],
+        "timestamp": 1536347807471
+      }
+```
+
+```Ruby
+data = Coincap::Rates.single('bitcoin')
+```
+```JSON
+      {
+        "data": [
+          {
+            "id": "barbadian-dollar",
+            "symbol": "BBD",
+            "currencySymbol": "$",
+            "type": "fiat",
+            "rateUsd": "0.5000000000000000"
+          },
+        ...
+        ],
+        "timestamp": 1536347807471
+      }
+```
+
+## Exchanges
+```Ruby
+data = Coincap::Exchanges.list
+```
+```JSON
+      {
+        "data": [
+          {
+            "id": "okex",
+            "name": "Okex",
+            "rank": "1",
+            "percentTotalVolume": "21.379485735166293542000000000000000000",
+            "volumeUsd": "616465445.1646260280799955",
+            "tradingPairs": "22",
+            "socket": false,
+            "exchangeUrl": "https://www.okex.com/",
+            "updated": 1536343139514
+          },
+        ...
+        ],
+        "timestamp": 1536605835421
+      }
+```
+
+```Ruby
+data = Coincap::Exchanges.single
+```
+```JSON
+      {
+        "data": {
+          "id": "kraken",
+          "name": "Kraken",
+          "rank": "4",
+          "percentTotalVolume": "2.946801735133553120000000000000000000",
+          "volumeUsd": "84969370.4499608426167365",
+          "tradingPairs": "52",
+          "socket": false,
+          "exchangeUrl": "https://kraken.com",
+          "updated": 1536343139468
+        },
+        "timestamp": 1536605874069
+      }
+```
+
+## Markets
+```Ruby
+data = Coincap::Markets.list
+```
+```JSON
+    {
+      "data": [
+        {
+          "exchangeId": "bitstamp",
+          "rank": "1",
+          "baseSymbol": "BTC",
+          "baseId": "bitcoin",
+          "quoteSymbol": "USD",
+          "quoteId": "united-states-dollar",
+          "priceQuote": "6927.3300000000000000",
+          "priceUsd": "6927.3300000000000000",
+          "volumeUsd24Hr": "43341291.9576547008000000",
+          "percentExchangeVolume": "67.2199253376108585",
+          "tradesCount24Hr": "420721",
+          "updated": 1533581033590
+        },
+      ...
+      ],
+      "timestamp": 1533581173350
+    }
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/coincap/assets_price.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+module Coincap
+  # The asset price is a volume-weighted average calculated by collecting ticker data from exchanges.
+  # Each exchange contributes to this price in relation to their volume,
+  # meaning higher volume exchanges have more affect on this global price.
+  # All values are translated into USD (United States Dollar)
+  # and can be translated into other units of measurement through the /rates endpoint.
+  module AssetsPrice
+    URI_API = 'https://api.coincap.io/v2/assets'
+
+    TIME_INTERVAL = {
+      one_minute: 'm1',
+      five_minutes: 'm5',
+      fifteen_minutes: 'm15',
+      thirty_minutes: 'm30',
+      one_hour: 'h1',
+      two_hours: 'h2',
+      six_hours: 'h6',
+      twelve_hours: 'h12',
+      one_day: 'd1'
+    }.freeze
+
+    # Get all cryptocurrencies
+    #
+    #   {
+    #     "data": [
+    #       {
+    #       "id": "bitcoin",
+    #       "rank": "1",
+    #       "symbol": "BTC",
+    #       "name": "Bitcoin",
+    #       "supply": "17193925.0000000000000000",
+    #       "maxSupply": "21000000.0000000000000000",
+    #       "marketCapUsd": "119150835874.4699281625807300",
+    #       "volumeUsd24Hr": "2927959461.1750323310959460",
+    #       "priceUsd": "6929.8217756835584756",
+    #       "changePercent24Hr": "-0.8101417214350335",
+    #       "vwap24Hr": "7175.0663247679233209"
+    #       },
+    #    ...
+    #     ],
+    #     "timestamp": 1533581088278
+    #   }
+    #
+    # @param [Hash] options
+    # @option options [String] :search (nil) Search by asset id (bitcoin) or symbol (BTC)
+    # @option options [String] :ids (nil) Query with multiple ids=bitcoin,ethereum,monero
+    # @option options [Integer] :limit (nil) Max limit of 2000
+    # @option options [Integer] :offset (nil) Offset
+    # @return [Hash]
+    def self.cryptocurrencies(**options)
+      quries = {
+        'search': options[:search],
+        'ids': options[:ids],
+        'limit': options[:limit],
+        'offset': options[:offset]
+      }
+      Helper.request_to_read_data(URI_API, **quries)
+    end
+
+    # Get single cryptocurrency
+    #
+    #   {
+    #     "data": {
+    #       "id": "bitcoin",
+    #       "rank": "1",
+    #       "symbol": "BTC",
+    #       "name": "Bitcoin",
+    #       "supply": "17193925.0000000000000000",
+    #       "maxSupply": "21000000.0000000000000000",
+    #       "marketCapUsd": "119179791817.6740161068269075",
+    #       "volumeUsd24Hr": "2928356777.6066665425687196",
+    #       "priceUsd": "6931.5058555666618359",
+    #       "changePercent24Hr": "-0.8101417214350335",
+    #       "vwap24Hr": "7175.0663247679233209"
+    #     },
+    #     "timestamp": 1533581098863
+    #   }
+    #
+    # @param [String] asset_id Asset id, for example, bitcoin
+    # @return [Hash]
+    def self.cryptocurrency(asset_id)
+      Helper.request_to_read_data("#{URI_API}/#{asset_id}")
+    end
+
+    # Get cryptocurrency history price
+    #
+    #   {
+    #     "data": [
+    #      {
+    #         "priceUsd": "6379.3997635993342453",
+    #         "time": 1530403200000
+    #       },
+    #     ...
+    #     ],
+    #     "timestamp": 1533581103627
+    #   }
+    #
+    # @param [String] asset_id Asset id, for example, bitcoin
+    # @param [Symbol] interval Select one from the list m1,m5,m15,m30,h1,h2,h6,h12,d1, for example, m1 or write a symbol, for example, :one_minute
+    def self.cryptocurrency_history(asset_id, interval)
+      Helper.request_to_read_data("#{URI_API}/#{asset_id}/history",
+                                  interval: interval.is_a?(Symbol) ? TIME_INTERVAL[interval] : interval)
+    end
+
+    # Get price cryptocurrency with markets
+    #
+    #   {
+    #     "data": [
+    #       {
+    #         "exchangeId": "Binance",
+    #         "baseId": "bitcoin",
+    #         "quoteId": "tether",
+    #         "baseSymbol": "BTC",
+    #         "quoteSymbol": "USDT",
+    #         "volumeUsd24Hr": "277775213.1923032624064566",
+    #         "priceUsd": "6263.8645034633024446",
+    #         "volumePercent": "7.4239157877678087"
+    #       },
+    #       ...
+    #     ],
+    #     "timestamp": 1539289444052
+    #   }
+    #
+    # @param [String] asset_id Asset id, for example, bitcoin
+    # @param [Integer] limit Max limit of 2000
+    # @param [Integer] offset Offset
+    def self.cryptocurrency_with_markets(asset_id, limit: nil, offset: nil)
+      Helper.request_to_read_data("#{URI_API}/#{asset_id}/markets", limit: limit, offset: offset)
+    end
+  end
+end

data/lib/coincap/exchanges.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+module Coincap
+  # The /exchanges endpoint offers an understanding into the where cryptocurrency
+  # is being exchanged and offers high-level information on those exchanges.
+  #
+  # CoinCap strives to provide transparency in the recency of our exchange data.
+  #
+  # For that purpose you will find an "updated" key for each exchange.
+  # For more details into coin pairs and volume, see the /markets endpoint.
+  module Exchanges
+    URI_API = 'https://api.coincap.io/v2/exchanges'
+
+    # Returns a list of all exchanges.
+    #
+    #   {
+    #     "data": [
+    #       {
+    #         "id": "okex",
+    #         "name": "Okex",
+    #         "rank": "1",
+    #         "percentTotalVolume": "21.379485735166293542000000000000000000",
+    #         "volumeUsd": "616465445.1646260280799955",
+    #         "tradingPairs": "22",
+    #         "socket": false,
+    #         "exchangeUrl": "https://www.okex.com/",
+    #         "updated": 1536343139514
+    #       },
+    #     ...
+    #     ],
+    #     "timestamp": 1536605835421
+    #   }
+    #
+    # @return [Hash]
+    def self.list
+      Helper.request_to_read_data(URI_API)
+    end
+
+    # Returns a single exchange.
+    #
+    #   {
+    #     "data": {
+    #       "id": "kraken",
+    #       "name": "Kraken",
+    #       "rank": "4",
+    #       "percentTotalVolume": "2.946801735133553120000000000000000000",
+    #       "volumeUsd": "84969370.4499608426167365",
+    #       "tradingPairs": "52",
+    #       "socket": false,
+    #       "exchangeUrl": "https://kraken.com",
+    #       "updated": 1536343139468
+    #     },
+    #     "timestamp": 1536605874069
+    #   }
+    #
+    # @param exchange_id [String]
+    # @return [Hash]
+    def self.single(exchange_id)
+      Helper.request_to_read_data("#{URI_API}/#{exchange_id}")
+    end
+  end
+end

data/lib/coincap/helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'json'
+require 'net/http'
+require 'openssl'
+
+module Coincap
+  # Helper module
+  module Helper
+    def self.request_to_read_data(uri_string, **queries_hash)
+      uri = convert_hash_to_uri(uri_string, **queries_hash)
+
+      data_str = http_get(uri)
+
+      JSON.parse(data_str)
+    end
+
+    class << self
+      private
+
+      def http_get(uri)
+        config = Coincap.instance_variable_get(:@config)
+
+        headers = {
+          'Accept-Encoding': config.accept_encoding,
+          'Authorization': config.api_key.nil? ? nil : "Bearer #{config.api_key}"
+        }
+
+        headers.compact!
+
+        Net::HTTP.get(uri, headers)
+      end
+
+      def convert_hash_to_uri(uri, **queries_hash)
+        queries_str = queries_hash.compact.map { |key, value| "#{key}=#{value}" }.join('&')
+        URI("#{uri}#{queries_str.empty? ? '' : "?#{queries_str}"}")
+      end
+    end
+  end
+end

data/lib/coincap/markets.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+module Coincap
+  # Take a closer look into exchanges with the /markets endpoint.
+  # Similar to the /exchanges endpoint, we strive to offer transparency into how real-time
+  # our data is with a key identifying when the market was last updated.
+  # For a historical view on how a market has performed, see the /candles endpoint.
+  # All market data represents actual trades processed, orders on an exchange are not represented.
+  # Data received from individual markets is used to calculate the current price of an asset.
+  module Markets
+    URI_API = 'https://api.coincap.io/v2/markets'
+
+    # Returns a list of all markets.
+    #
+    #   {
+    #     "data": [
+    #       {
+    #         "exchangeId": "bitstamp",
+    #         "rank": "1",
+    #         "baseSymbol": "BTC",
+    #         "baseId": "bitcoin",
+    #         "quoteSymbol": "USD",
+    #         "quoteId": "united-states-dollar",
+    #         "priceQuote": "6927.3300000000000000",
+    #         "priceUsd": "6927.3300000000000000",
+    #         "volumeUsd24Hr": "43341291.9576547008000000",
+    #         "percentExchangeVolume": "67.2199253376108585",
+    #         "tradesCount24Hr": "420721",
+    #         "updated": 1533581033590
+    #       },
+    #     ...
+    #     ],
+    #     "timestamp": 1533581173350
+    #   }
+    #
+    # @param options [Hash] options for the request
+    # @option options [String] :exchange_id (nil) Search by exchange id (e.g. 'binance')
+    # @option options [String] :base_symbol (nil) Returns all containing the base symbol
+    # @option options [String] :quote_symbol (nil) Returns all containing the quote symbol
+    # @option options [String] :base_id (nil) Returns all containing the base id
+    # @option options [String] :quote_id (nil) Returns all containing the quote id
+    # @option options [String] :asset_symbol (nil) Returns all assets containing symbol (base and quote)
+    # @option options [String] :asset_id (nil) Returns all assets containing id (base and quote)
+    # @option options [Integer] :limit (nil) Max limit of 2000
+    # @option options [Integer] :offset (nil) The number of results to skip
+    # @return [Hash]
+    def self.list(**options)
+      queries = {
+        'exchangeId': options[:exchange_id],
+        'baseSymbol': options[:base_symbol],
+        'quoteSymbol': options[:quote_symbol],
+        'baseId': options[:base_id],
+        'quoteId': options[:quote_id],
+        'assetSymbol': options[:asset_symbol],
+        'assetId': options[:asset_id],
+        'limit': options[:limit],
+        'offset': options[:offset]
+      }
+      Helper.request_to_read_data(URI_API, **queries)
+    end
+  end
+end

data/lib/coincap/rates.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+
+module Coincap
+  # All prices on the CoinCap API are standardized in USD (United States Dollar).
+  # To make translating to other values easy, CoinCap now offers a Rates endpoint.
+  # We offer fiat and top cryptocurrency translated rates.
+  # Fiat rates are available through OpenExchangeRates.org.
+  module Rates
+    URI_API = 'https://api.coincap.io/v2/rates'
+
+    # Returns a list of all rates.
+    #
+    #   {
+    #     "data": [
+    #       {
+    #         "id": "barbadian-dollar",
+    #         "symbol": "BBD",
+    #         "currencySymbol": "$",
+    #         "type": "fiat",
+    #         "rateUsd": "0.5000000000000000"
+    #       },
+    #     ...
+    #     ],
+    #     "timestamp": 1536347807471
+    #   }
+    #
+    # @return [Hash]
+    def self.list
+      Helper.request_to_read_data(URI_API)
+    end
+
+    # Returns a single rate.
+    #
+    #   {
+    #     "data": {
+    #       "id": "bitcoin",
+    #       "symbol": "BTC",
+    #       "currencySymbol": "₿",
+    #       "type": "crypto",
+    #       "rateUsd": "6444.3132749056076909"
+    #     },
+    #     "timestamp": 1536347871542
+    #   }
+    #
+    # @param asset_id [String] The asset id (bitcoin)
+    # @return [Hash]
+    def self.single(asset_id)
+      Helper.request_to_read_data("#{URI_API}/#{asset_id}")
+    end
+  end
+end

data/lib/coincap/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Coincap
+  VERSION = '0.1.0'
+end

data/lib/coincap.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'coincap/version'
+require_relative 'coincap/assets_price'
+require_relative 'coincap/helper'
+require_relative 'coincap/markets'
+require_relative 'coincap/rates'
+require_relative 'coincap/exchanges'
+
+# CoinCap 2.0 RESTful API is currently in production!
+# The CoinCap team is excited to offer you new endpoints and more clarity on pricing!
+# CoinCap 2.0 launched on September 26, 2018.
+# Please let us know what you like, what you would hope to see, or any bugs/changes that you'd like to document.
+# The easiest way to submit feedback to our team is to fill out a support ticket here.
+# The old CoinCap API is deprecated and was shut down on March 1, 2019.
+# For any issues with transitioning from the old CoinCap API to the new,
+# please submit feedback via the zendesk link above!
+module Coincap
+  # Configuration class for Coincap
+  class Configuration
+    # @return [String] The API key to use for all requests.
+    attr_accessor :api_key
+    # @return [String] The accept encoding to use for all requests. Select 'gzip' or 'deflate'. Defaults to 'gzip'.
+    attr_accessor :accept_encoding
+
+    def initialize(api_key = nil, accept_encoding = 'gzip')
+      @api_key = api_key
+      @accept_encoding = accept_encoding
+    end
+  end
+
+  @config = Configuration.new
+
+  def self.configure
+    # @yield [Coincap::Configuration]
+    yield @config
+    @config.accept_encoding
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: coincap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cosmic-1
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-12 00:00:00.000000000 Z
+dependencies: []
+description: CoinCap is a useful tool for real-time pricing and market activity for
+  over 1,000 cryptocurrencies.
+email:
+- crossdoh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/coincap.rb
+- lib/coincap/assets_price.rb
+- lib/coincap/exchanges.rb
+- lib/coincap/helper.rb
+- lib/coincap/markets.rb
+- lib/coincap/rates.rb
+- lib/coincap/version.rb
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/Cosmic-1/coincap
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: CoinCap is a useful tool for real-time pricing and market activity for over
+  1,000 cryptocurrencies.
+test_files: []