Cryptocompare Api

Gem cryptocompare Ruby library provides convenient access to the cryptocompare from applications written in the Ruby language.

See documentation: API docs.

Table of Contents

• Cryptocompare Api
  • Table of Contents
  • Installation
  • Usage
    • Configuration
    • Methods
      • Convert
        • Params
        • Options
      • Full Data
        • Params
        • Options
      • Generate Custom Average
        • Params
        • Options
  • Middleware
  • Response
  • Strict
  • Contributing
  • License

Installation

Add this line to your application's Gemfile:

gem 'cryptocompare'

And then execute:

bundle install

Usage

Configuration

You can configure the client for each request or confugre factory with defualt values:

require 'cryptocompare'

Cryptocompare::Client.configure do |config|
  config.api_key = "YOUR_API_KEY"
  config.pure_hash = true
  # ...
end

client = Cryptocompare::Client.get(options) # Options rewrite default values, not require
# or
client = Cryptocompare::Client.new(api_key: "YOUR_API_KEY", options)

Methods

Convert

Single Symbol Price. Get the current price of any cryptocurrency in any other currency that you need.

If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion. If the opposite pair trades we invert it (eg.: BTC-XMR)

Params

• fsym string Required The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
• tsyms array by string Required Comma separated cryptocurrency symbols list to convert into [ Min length - 1] [ Max length - 500]

Options

1. try_conversion boolean If set to false, it will try to get only direct trading values. This parameter is only valid for e=CCCAGG value [ Default - true]
2. relaxed_validation boolean Setting this to true will make sure you don't get an error on non trading pairs, they will just be filtered out of the response. [ Default - true]
3. e string The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - cccagg_or_exchange]
4. extra_params string The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
5. sign boolean If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]
6. pure_hash boolean If set to true, the server will return the hash instead of the response (Convert will be throught default JSON.parse) [ Default - false]

To get the data, you need to call the method:

response = client.convert(fsym: "BTC", tsyms: ["ETH", "USD"])

Full Data

Multiple Symbols Full Data. Get all the current trading info (price, vol, open, high, low etc) of any list of cryptocurrencies in any other currency that you need. If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion.

This API also returns Display values for all the fields. If the opposite pair trades we invert it (eg.: BTC-XMR)

Params

• fsym string Required The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
• tsyms array by string Required Comma separated cryptocurrency symbols list to convert into [ Min length - 1] [ Max length - 500]

Options

1. try_conversion boolean If set to false, it will try to get only direct trading values. This parameter is only valid for e=CCCAGG value [ Default - true]
2. relaxed_validation boolean Setting this to true will make sure you don't get an error on non trading pairs, they will just be filtered out of the response. [ Default - true]
3. e string The exchange to obtain data from [ Min length - 2] [ Max length - 30] [ Default - cccagg_or_exchange]
4. extra_params string The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
5. sign boolean If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]
6. pure_hash boolean If set to true, the server will return the hash instead of the response (Convert will be throught default JSON.parse) [ Default - false]

To get the data, you need to call the method:

response = client.full_data(fsym: "BTC", tsyms: ["ETH", "USD"])

Generate Custom Average

Compute the current trading info (price, vol, open, high, low etc) of the requested pair as a volume weighted average based on the exchanges requested.

Params

• fsym string Required The cryptocurrency symbol of interest [ Min length - 1] [ Max length - 30]
• tsym string Required The currency symbol to convert into [ Min length - 1] [ Max length - 30]
• e string Required The exchange to obtain data from [ Min length - 2] [ Max length - 150]

Options

1. extra_params string The name of your application (we recommend you send it) [ Min length - 1] [ Max length - 2000] [ Default - NotAvailable]
2. sign boolean If set to true, the server will sign the requests (by default we don't sign them), this is useful for usage in smart contracts [ Default - false]
3. pure_hash boolean If set to true, the server will return the hash instead of the response (Convert will be throught default JSON.parse) [ Default - false]

To get the data, you need to call the method:

response = client.generate_custom_average(fsym: "BTC", tsym: "USD", e: "Coinbase,Bitfinex")

Middleware

Gem use a faraday for http request, you can set middleaware, example:

response = client.convert(fsym: "BTC", tsyms: ["ETH", "USD"]) do |f|
  f.request :json
  f.request :logger
  f.response :json
  f.adapter :net_http
  # ...
end

Response

If not use flag pure_hash response will be object with methods:

1. response.status - return true if the http request has successful http status
2. response.value - return the pure response from http client
3. response.error - return pure message from Cryptocompare if request is not successful

Strict

Clent can send strict requests, example:

response = client.convert!(fsym: "BTC", tsyms: ["ETH", "USD"])

Raise an error if the http request is not successful. Error types:

# TODO: add all types of errors
Cryptocompare::NotSuccessful #return pure response from Cryptocompare
Cryptocompare::InternalError #unexpected error

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

License

The gem is available as open source under the terms of the MIT License.