0.0
The project is in a healthy, maintained state
Ruby gem for the OKEX Exchange API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Runtime

~> 0.19
~> 2.2
 Project Readme

OKEX::API

This gem is a ruby SDK for the OKEX crypto exchange REST API.

API docs can be found on the OKEX developer site

Installation

Add this line to your application's Gemfile:

gem 'okex-ruby-api'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install okex-ruby-api

Usage

Markets

Initialize a markets session:

markets = OKEX::API::Markets.new

Query for all current futures specs:

markets.list(type: :futures)

Query for all current spot specs:

markets.list(type: :spot)

Query for all current futures prices:

markets.tickers(type: :futures)

Query for all current spot prices:

markets.tickers(type: :spot)

Fetch a single current futures price:

markets.ticker('BTC-USDT-220325', type: :futures)

Fetch a single current spot price:

markets.ticker('BTC-USDT', type: :spot)

Note: type is optional and defaults to 'spot'.

Development

After checking out the repo, run bin/setup to install dependencies.

You'll then need to add environment variables ENV['OKEX_KEY'] and ENV['OKEX_SECRET']. API keys can be created in your OKEX settings page.

Then, run rake test 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/benrs44/okex-ruby-api. 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 Ftx::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.