The project is in a healthy, maintained state
MAX Exchange API Ruby SDK
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.17, < 3.x
~> 5.0
~> 12.0

Runtime

>= 0.18.1
 Project Readme

MAX Exchange API Ruby SDK

Gem Version Build Status RubyGems Code Climate Test Coverage

A ruby implementation of MAX exchange API

  • REST API V2
  • REST API V3
  • Websocket API

Table of contents

  • MAX Exchange API Ruby SDK
    • Documentations
    • Supports
    • Table of contents
    • Installation
    • Usage
    • Development
    • Contributing
    • License

Supports

  • Ruby 2.2 ~ 2.7, 3.0 ~ 3.3

Installation

gem 'max_exchange_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install max_exchange_api

Usage

Development

After checking out the repo, run bin/setup to install dependencies. 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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/max_exchange_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.