danmaz74 / poloniex

A ruby wrapper for the poloniex.com api

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Poloniex

Gem Version

This gem provides a ruby wrapper to the poloniex.com api: Link

Installation

Add this line to your application's Gemfile:

gem 'poloniex'

And then execute:

$ bundle

Or install it yourself as:

$ gem install poloniex

Usage

All methods provided by Poloniex are class methods, and are of the same name as the api ( except that "return"s have been removed ).

For example, https://www.poloniex.com/public?command=returnTicker is written as Poloniex.ticker

The Poloniex module accepts a setup block for configuration:

Poloniex.setup do | config |
    config.key = 'my api key'
    config.secret = 'my secret token'
end

GET requests ( to /public ) do not need authentication, and therefor do not need Poloniex to be configured.

POST requests ( to /tradingApi ) will need authentication, and you will have to have your own key and secret token.

Contributing

  1. Fork it
  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 new Pull Request

About

A ruby wrapper for the poloniex.com api

License:MIT License


Languages

Language:Ruby 100.0%