YobitApi
This gem provides a wrapper for the yobit.net api: yobit.net
Installation
Add this line to your application's Gemfile:
gem 'yobit_api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install yobit_api
Usage
-
Initialize:
client = YobitApi::Client.new
-
Setup your API key (for Trade API):
Use:
client = YobitApi::Client.new(key: 'key', secret: 'secret', key_init_date: '01.01.2018')
Where key_init_date = api key release date or first usage day date.
Or:
client.config.key = key client.config.secret = secret client.config.key_init_date = '01.01.2018'
-
Use the api:
client.info
Full list of supported methods, see yobit for usage.
Public API:
info ticker(['usd_rur']) depth(pairs_list: ['usd_rur'], limit: 1) trades(pairs_list: ['usd_rur'], limit: 1)
Trade API:
get_info trade(pair: 'usd_rur', type: 'buy', rate: 1, amount: 1) active_orders('usd_rur') order_info(1) cancel_order(1) trade_history(pair: 'usd_rur') get_deposit_address(coin_name: 'BTC', need_new: 0) withdraw_coins_to_address(coin_name: 'BTC', amount: 1, address: 'address')
Development
After checking out the repo, run bin/setup
to install dependencies. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ThinkAndRun/yobit_api.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
The gem is available as open source under the terms of the MIT License.