0.0
No commit activity in last 3 years
No release in over 3 years
Unofficial API Client for the CoinMarketCal API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 10.0

Runtime

 Project Readme

Coinmarketcal Gem Version

Unofficial gem for the CoinMarketCal API.

CoinMarketCal is the economic calendar for the cryptocurrency market. Evidence-based and community-driven.

Installation

Add this line to your application's Gemfile:

gem 'coinmarketcal'

And then execute:

$ bundle

Or install it yourself as:

$ gem install coinmarketcal

Usage

You can authenticate access to your CoinMarketCal account by configuring your implementation of the coinmarketcal gem. This is accomplished by using a config block at the top of your application.

Set up your keys at: https://api.coinmarketcal.com/developer/dashboard

Coinmarketcal.config do |c|
  c.client_id = 'your-client-id'
  c.client_secret = 'your-client-secret'
end

To retrieve list of coins:

Coinmarketcal::Coin.all

To retrieve list of events:

Coinmarketcal::Event.all coins: "bitcoin,ethereum",
                         max: 10,
                         sort_by: "created_desc",
                         date_range_start: "30/07/2018",
                         date_range_end: "30/08/2018"

To retrieve list of categories:

Coinmarketcal::Category.all

For more information about API, visit https://api.coinmarketcal.com/

Contributing

  1. Fork it ( https://github.com/toreserter/coinmarketcal/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

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