https://github.com/mwerner/bittrex

Unofficial gem for the Bittrex API
https://github.com/mwerner/bittrex

Last synced: about 1 year ago
JSON representation

Unofficial gem for the Bittrex API

• Host: GitHub
• URL: https://github.com/mwerner/bittrex
• Owner: mwerner
• License: mit
• Created: 2014-06-26T05:59:30.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2018-02-27T04:03:10.000Z (over 8 years ago)
• Last Synced: 2025-03-31T16:16:01.564Z (over 1 year ago)
• Language: Ruby
• Size: 36.1 KB
• Stars: 53
• Watchers: 4
• Forks: 84
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Bittrex

Unofficial gem for the Bittrex API

## Installation

Add this line to your application's Gemfile:

    gem 'bittrex'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install bittrex

## Usage

The gem uses a simple mapping of API resources to models, with a majority of the attributes mapped to corresponding attributes on the corresponding class. There are some translations into a more "rubyish" verbage, but for the most part things are directly mapped.

    require 'rubygems'

    require 'bittrex'

    >> Quote.current('BTC-LTC')

    #=> #0.015792, "Ask"=>0.01602899, "Last"=>0.015792}>

## Authentication

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

Set up your keys at: https://bittrex.com/Manage#sectionApi

    Bittrex.config do |c|

      c.key = 'my_api_key'

      c.secret = 'my_api_secret'

    end

## Development

You can test out public API calls any time by running `bundle exec rake bittrex:console` and inputting your method.

If you want to test private API calls, you will need to create `config/application.yml` and add your Bittrex keys to it (`config/application.yml.example` provides a template for this).

Once you've added the API keys, run `bundle exec rake bittrex:console`

## Contributing

1. Fork it ( https://github.com/[my-github-username]/bittrex/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