A ruby gem for easy integration of Quidax. Please kindly see the docs to get a sense of how the API behaves
Add this line to your application's Gemfile:
gem 'quidax'And then execute:
$ bundle install
Or install it yourself as:
$ gem install quidax
To use the SDK, you need to instantiate a quidax object with a secret key
secret_key = ENV["QUIDAX_SECRET_KEY"]
quidax_object = Quidax.new(secret_key)
See the table below for a list of available objects. Kindly note that all objects and methods accepts parameters via named keywords. There are two ways to use an object:
In this case you need to pass your quidax_object once to the object instance, and you will now be able to access methods on the class. The keyword is q_object
markets = QuidaxMarkets(q_object: quidax_object)
all_market_tickers = markets.get_all_tickers
In this case you need to pass quidax_object to the method you directly calling, the keyword is q_object
all_market_tickers = QuidaxMarket.get_all_tickers(q_object: quidax_object)
Like you may suspect, the parameters that each method differs, please kindly see the docs to know the expected parameters,
query:is used to get requests with a payload, whilebody:is used forpost/putrequests with a payload
| Object | Methods |
|---|---|
| QuidaxBeneficiary | get_all create get_account edit_account |
| QuidaxDeposits | by_user get_a_deposit by_sub_users |
| QuidaxInstantOrder | get_all by_sub_users get_detail buy_crypto_from_fiat sell_crypto_to_fiat confirm requote |
| QuidaxMarkets | get_all get_all_tickers get_ticker get_k_line get_k_line_with_pending_trades get_orderbook_items get_depth_for_a_market |
| QuidaxOrder | get_all create cancle get_details |
| QuidaxQuote | get |
| QuidaxTrade | for_user for_market |
| QuidaxUser | get_account_details create_sub_account get_all_sub_accounts edit_account |
| QuidaxWallet | get_user_wallets get_user_wallet get_payment_address get_payment_address_by_id get_payment_addresses create_crypto_payment_address validate_address |
| QuidaxWithdrawal | get_all_withdrawals_detail get_detail cancel |
Bug reports and pull requests are welcome on GitHub at https://github.com/aremu-smog/quidax-ruby.
The gem is available as open source under the terms of the MIT License.