Module: Cryptocompare::PriceHistorical

Defined in:
lib/cryptocompare/price_historical.rb

Class Method Summary collapse

Class Method Details

.find(from_sym, to_syms, opts = {}) ⇒ Object

Finds the price of any cryptocurrency in any other currency that you need at a given timestamp. The price comes from the daily info - so it would be the price at the end of the day GMT based on the requested timestamp. If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion. Tries to get direct trading pair data, if there is none or it is more than 30 days before the ts requested, it uses BTC conversion. If the opposite pair trades we invert it (eg.: BTC-XMR).

Parameters

  • from_sym [String] - (required) currency symbol (ex: ‘BTC’, ‘ETH’, ‘LTC’, ‘USD’, ‘EUR’, ‘CNY’)

  • to_syms [String, Array] - (required) currency symbol(s) (ex: ‘USD’, ‘EUR’, ‘CNY’, ‘USD’, ‘EUR’, ‘CNY’)

  • opts [Hash] - (optional) options hash

Options

  • ts [String, Integer] - (optional) timestamp

Returns

Hash

Hash with currency prices

Examples

Find historical price of cryptocurrency.

Cryptocompare::PriceHistorical.find('ETH', 'USD')
#=> {"ETH"=>{"USD"=>225.93}}

Find historical price of cryptocurrency at a given timestamp.

Cryptocompare::PriceHistorical.find('ETH', 'USD', {'ts' => 1452680400})
#=> {"ETH"=>{"USD"=>223.2}}

Find historical price of cryptocurrency in many currencies at a given timestamp.

Cryptocompare::PriceHistorical.find('ETH', ['BTC', 'USD', 'EUR'], {'ts' => '1452680400'})
#=> {"ETH"=>{"BTC"=>0.08006, "USD"=>225.93, "EUR"=>194.24}}



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/cryptocompare/price_historical.rb', line 47

def self.find(from_sym, to_syms, opts = {})
  params = {
    'from_sym' => from_sym,
    'to_syms'  => Array(to_syms).join(',')
  }.merge!(opts)

  full_path = QueryParamHelper.set_query_params(API_URL, params)
  api_resp = Faraday.get(full_path)
  JSON.parse(api_resp.body)
end