/bitfinex-api-rb

BITFINEX Ruby trading API - Bitcoin, Litecoin, and Ether exchange

Primary LanguageRubyMIT LicenseMIT

Bitfinex Trading API for Ruby. Bitcoin, Ether and Litecoin trading

Code Climate

  • Official implementation
  • REST API
  • WebSockets API
  • REST API version 2
  • WebSockets API version 2

Installation

Add this line to your application's Gemfile:

gem 'bitfinex-rb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bitfinex-rb

Usage

Configure your gem as:

Bitfinex::Client.configure do |conf|
  # add `secret` and `api_key` if you need to access authenticated endpoints.
  conf.secret = ENV["BFX_API_SECRET"]
  conf.api_key = ENV["BFX_API_KEY"]

  # uncomment if you want to use version 2 of the API
  # which is opt-in at the moment
  #
  # conf.use_api_v2
end

Then you can use the client as follow:

client = Bitfinex::Client.new
client.balances

check the Bitfinex API documentation for more information.

Contributing

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