Class: CoinCapper

Inherits:
Object
  • Object
show all
Defined in:
lib/coincapper.rb,
lib/coincapper/version.rb

Constant Summary collapse

API_URL = 
'https://api.coinmarketcap.com/v1'.freeze
BASE_URL = 
'https://coinmarketcap.com'.freeze
VERSION = 
'1.2.1'

Class Method Summary collapse

Class Method Details

.all(type) ⇒ Array<Hash>

Returns list of cryptocurrencies by type (coins, tokens)

Parameters:

  • Cryptocurrency type. i.e. ‘coins’ or ‘tokens’

Returns:

  • List of all coins (or tokens)



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/coincapper.rb', line 135

def all(type)
  return { error: 'invalid type' } unless /coins|tokens/ =~ type

  url = "#{BASE_URL}/#{type}/views/all/"
  response = HTTP.get(url)
  html = Nokogiri::HTML(response.body.to_s)
  table = html.css('table#currencies-all, table#assets-all')
  rows = table.css('tbody tr')

  cryptos = rows.each_with_object([]) do |row, arr|
    td = row.css('td')
    arr << {
      id: row&.attribute('id')&.text[/id-(.+)/, 1],
      rank: td[0].text.to_i,
      name: td[1].css('a.currency-name-container').text.strip,
      symbol: type.eql?('coins') ? td[2].text : nil,
      platform: type.eql?('tokens') ? td[2].text : nil,
      market_cap_usd: td[3]&.attribute('data-usd')&.text.to_f,
      market_cap_btc: td[3]&.attribute('data-btc')&.text.to_f,
      price_usd: td[4].css('a.price')&.attribute('data-usd')&.text.to_f,
      price_btc: td[4].css('a.price')&.attribute('data-btc')&.text.to_f,
      circulating_supply: td[5].css('a, span')&.attribute('data-supply')&.text.to_f,
      volume_usd_24h: td[6].css('a')&.attribute('data-usd')&.text.to_f,
      volume_btc_24h: td[6].css('a')&.attribute('data-btc')&.text.to_f,
      percent_change_1h: td[7]&.attribute('data-usd')&.text.to_f,
      percent_change_24h: td[8]&.attribute('data-usd')&.text.to_f,
      percent_change_7d: td[9]&.attribute('data-usd')&.text.to_f
    }.compact
  end

  cryptos
rescue StandardError => e
  {
    message: 'An unknown error occurred. Please submit a GitHub issue if problem continues.',
    error: e.message
  }
end

.coin(id, currency: nil) ⇒ Hash

Parameters:

  • Coinmarketcap coin id

  • (defaults to: nil)

    Country currency code to convert price

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/coincapper.rb', line 36

def coin(id, currency: nil)
  params = {
    convert: currency
  }.compact.to_param

  url = "#{API_URL}/ticker/#{id}/"
  url << "?#{params}" if params.present?

  response = HTTP.get(url)
  json = JSON.parse(response.body.to_s, symbolize_names: true)
  json.is_a?(Array) ? json.first : json
end

.coin_by_symbol(symbol) ⇒ Hash

Parameters:

  • Coin symbol

Returns:



51
52
53
54
55
 
# File 'lib/coincapper.rb', line 51

def coin_by_symbol(symbol)
  response = HTTP.get("#{API_URL}/ticker/?limit=0")
  json = JSON.parse(response.body.to_s, symbolize_names: true)
  json.find { |x| x[:symbol].strip.casecmp(symbol.strip.upcase).zero? }
end

.coin_markets(id: nil, symbol: nil) ⇒ Array<Hash>

Parameters:

  • (defaults to: nil)

    Coin market cap id

  • (defaults to: nil)

    Coin symbol

Returns:

Raises:



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/coincapper.rb', line 60

def coin_markets(id: nil, symbol: nil)
  raise ArgumentError.new('id or symbol is required') if id.blank? && symbol.blank?

  coin_id = symbol.present? ? coin_by_symbol(symbol)[:id] : id
  response = HTTP.get("#{BASE_URL}/currencies/#{coin_id}/\#markets")
  html = Nokogiri::HTML(response.body.to_s)
  rows = html.css('table#markets-table tbody tr')
  return { error: 'invalid id' } if rows.blank?

  markets = rows.each_with_object([]) do |row, arr|
    td = row.css('td')
    arr << {
      source: td[1].text.strip,
      pair: td[2].text.strip,
      volume_usd: td[3].text.strip[/\$(.+)/, 1].delete(',').to_f,
      price_usd: td[4].text.strip[/\$(.+)/, 1].delete(',').to_f,
      volume_percentage: td[5].text.to_f,
      last_updated: td[6].text.strip
    }
  end

  markets
end

.coins(limit: 0, rank: nil, currency: nil) ⇒ Array<Hash>

Parameters:

  • (defaults to: nil)

    Coins market cap rank greater than or equal

  • (defaults to: 0)

    Maximum limit set. Defaults to 0 to return all results

  • (defaults to: nil)

    Country currency code to convert price

Returns:

See Also:



19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/coincapper.rb', line 19

def coins(limit: 0, rank: nil, currency: nil)
  params = {
    limit: limit,
    start: rank,
    convert: currency
  }.compact.to_param

  url = "#{API_URL}/ticker/"
  url << "?#{params}" if params.present?

  response = HTTP.get(url)
  JSON.parse(response.body.to_s, symbolize_names: true)
end

.global(currency: nil) ⇒ Hash

Parameters:

  • (defaults to: nil)

    Country currency code to convert price

Returns:



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/coincapper.rb', line 86

def global(currency: nil)
  params = {
    convert: currency
  }.compact.to_param

  url = "#{API_URL}/global/"
  url << "?#{params}" if params.present?

  response = HTTP.get(url)
  JSON.parse(response.body.to_s, symbolize_names: true)
end

.historical_price(id, start_date, end_date) ⇒ Array<Hash>

Parameters:

  • Coinmarketcap coin id

  • Start date (YYYY-MM-DD)

  • End date (YYYY-MM-DD)

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/coincapper.rb', line 102

def historical_price(id, start_date, end_date)
  sd = parse_date(start_date, format: '%Y%m%d')
  ed = parse_date(end_date, format: '%Y%m%d')
  return { error: 'invalid date format' } if sd.blank? || ed.blank?

  url = "#{BASE_URL}/currencies/#{id}/historical-data/?start=#{sd}&end=#{ed}"
  response = HTTP.get(url)
  html = Nokogiri::HTML(response.body.to_s)
  rows = html.css('#historical-data table tbody tr')
  return { error: 'invalid id' } if rows.blank?

  prices = rows.each_with_object([]) do |row, arr|
    td = row.css('td')
    daily = {
      date: parse_date(td[0].text, format: '%F'),
      open: td[1].text.delete(',').to_f,
      high: td[2].text.delete(',').to_f,
      low: td[3].text.delete(',').to_f,
      close: td[4].text.delete(',').to_f,
      volume: td[5].text.delete(',').to_f,
      market_cap: td[6].text.delete(',').to_f
    }

    daily[:average] = ((daily[:high] + daily[:low]).to_d / 2).to_f
    arr << daily
  end

  prices
end