Skip to content

An easy-to-use client/wrapper for CoinGecko's crypto API

License

Notifications You must be signed in to change notification settings

julianfssen/coingecko_ruby

Repository files navigation

test suite

CoingeckoRuby

CoingeckoRuby is an easy-to-use client/wrapper for CoinGecko's awesome cryptocurrency API.

Installation

Add this line to your application's Gemfile:

  gem 'coingecko_ruby'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install coingecko_ruby

Usage

  1. Require the gem if you're not using Rails or if your environment does not autoload libraries.
require 'coingecko_ruby'
  1. Create a client instance.
client = CoingeckoRuby::Client.new
  1. Use the client to fetch your desired data.
# Example: Fetching the current price of Bitcoin.
client.price('bitcoin')

Documentation

Read the API documentation here:

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/julianfssen/coingecko_ruby.

License

MIT License

Copyright (c) 2021 Julian Foo Siang Sen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.