Project

huobi_api

0.01
No commit activity in last 3 years
No release in over 3 years
A ruby wrapper for the Huobi Pro API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

>= 1.15
>= 10.0
>= 3.0

Runtime

>= 2.0
>= 1.5
 Project Readme

HuboiApi

A ruby wrapper for the Huobi Pro API

So far just a few endpoints have been implemented, but adding more is simple and welcome. See lib/huobi_api/orders.rb and the huobi docs to get started.

Installation

Add this line to your application's Gemfile:

gem 'huboi_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install huboi_api

Usage

Config

HuobiApi.configure do |config|
  # confusingly the account_id is got from the API - see below - it is different from the UID show on the website
  config.account_id = 123456
  # key and secret from API Management page on Huobi website
  config.key = 'xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxx'
  config.secret = 'yyyyyyyy-yyyyyyyy-yyyyyyyy-yyyyy'
end

Making calls

HuobiApi.new_order(amount: 100, side: :sell, symbol: :xrpbtc, type: :market)
# => => {"status"=>"ok", "data"=>"12345678"}

HuobiApi.order_info(order_id: 12345678)
# => {"account-id"=>"123456", "amount"=>"100", "source"=>"api", "symbol"=>"xrpbtc", "type"=>"buy-market"}

Getting your account_id

HuobiApi.configure do |config|
  config.key = 'xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxx'
  config.secret = 'yyyyyyyy-yyyyyyyy-yyyyyyyy-yyyyy'
end

HuobiApi.accounts
# => {"status"=>"ok", "data"=>[{"id"=>123456, "type"=>"spot", "subtype"=>"", "state"=>"working"}]}

Your account_id is 123456.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests (though you may need to write some tests first). 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/[USERNAME]/huboi_api.