BinanceClient
This is a ruby api wrapper for Binance API
Installation
Add this line to your application's Gemfile:
gem 'binance_client'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install binance_client
Authenticate
client = BinanceClient.new(
api_key: "your-api-key",
api_secret: "your-api-secret"
)
Requests
We provide one method per API endpoint.
Current methods/endpoints
client.system_status
client.account_snapshot
client.coins_info
client.book_ticker("BTCETH")
client.order_book_depth(symbol: "BTCUSDT", limit: 100)
See spec/acceptance
for all calls.
Responses
The default representation of response data is a JSON hash
Hooks
You can set a hook to do application-specific things per request. This is useful when monitoring the rate limits:
BinanceClient.configuration.after_response = DoSomethingAfterBinanceResponse
What you assign can be a proc -- it just needs to respond to call
and accept the BinanceClient
response object:
class DoSomethingAfterBinanceResponse
def self.call(request, response)
response.used_weights # Ruby hash of the headers of all the possible used weights
end
end
Development
Edit the config.yml.sample
with your own credentials for testing
Factories
To make testing easier in your app, require "binance_client/factories"
to get access to factories of the models.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/bloom-solutions/binance_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the BinanceClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.