mwerner/bittrex

Unofficial gem for the Bittrex API

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')
#=> #<Bittrex::Quote:0x000001015cd058 @market="BTC-LTC", @bid=0.015792, @ask=0.01602899, @last=0.015792, @raw={"Bid"=>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

bittrex's Issues

Buy and Sell Functionality

Am I missing something or does this lack the ability to place buy and sell orders?

RE: creating buy and sells

Hey, I am thinking about using this gem for a project I am working on. I looked through the code base and not sure there is a way to create buy and sell orders, wondering if there is one and if not maybe i can help add it to the gem?

Does the gem support api V1.1

As in the title.

V2

Will version 2 be supported?
Thank you for the great work.

request_url is malformed

Set config on a per client basis

Currently the api key and api secret is set at a Gem level config using:

Bittrex.config do |c|
  c.key = 'my_api_key'
  c.secret = 'my_api_secret'
end

I have a use case for calling the api using different api keys in the same program, and would like to set it at a client level. So something like:

client_1 = Bittrex::Client.new(key: 'key_1', secret: 'secret_1')
wallet_1 = client_1.wallet
client_2 = Bittrex::Client.new(key: 'key_2', secret: 'secret_2')
wallet_2 = client_2.wallet
# do something with wallet_1 and wallet_2

I don't think this gem currently supports this (otherwise please point me in the right direction). I think it would be really helpful. Thank you!

undefined method `values' for #<Array:0x007fb57548a4b8> in Wallet.all

[6] pry(main)> Bittrex::Wallet.all
NoMethodError: undefined method `values' for #<Array:0x007fb57548a4b8>

Looks like the API response is an array of JSON object now.

Implement get market summaries call

Currently there is no way to get all bid/asks for all markets at once (or is there?), I have to get quotes one by one and it is very slow. API documentation describe it here
https://bittrex.com/Home/Api (search /public/getmarketsummaries)

Any chance this could be implemented?

websockets

What about websockets? Is there any documentation? I can't find anything on Bittrex ApiDocumentation page.