ViaBTC 📈

An HTTP client to interface with the open-source ViaBTC Exchange Server.

Installation

Add viabtc to your Gemfile and run bundle OR install it yourself with gem install viabtc.

Configuration

If using Rails, create a file named viabtc.rb under config/initializers and add the following block of code.

ViaBTC.configure do |config|
  config.http_base_url = 'http://localhost:18080'
end

If not, add it anywhere in your code that runs before a new client is initialized. Read more at: 📖 Configuration Wiki

Usage

Create a new instance:

viabtc_http_client = ViaBTC::HTTP::Client.new

Make an API request:

viabtc_http_client.market_status(market: 'ETHBTC')

#=> {"error"=>nil, "result"=>{"low"=>"0", "period"=>86400, "last"=>"0", "high"=>"0", "open"=>"0", "volume"=>"0", "close"=>"0", "deal"=>"0"}, "id"=>0}

Support

Ruby Versions Tested Against

✅ 3.1.1 (stable)
✅ 3.0.3 (stable)
✅ 2.7.5 (stable)
⏳ 2.6.9 (security maintenance)

ViaBTC Exchange Server API Support

📖 HTTP Protocol

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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.

Contributing

Fork the repository
Switch to develop branch (git checkout develop)
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

Donations ❤️

You can donate me at Liberapay. Thanks! ☕️

Is it any good?

Yes.

License

This gem is available under the terms of the MIT License.