Project

quidax

0.0
The project is in a healthy, maintained state
Ruby gem for Quidax
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.8.1
~> 3.19

Runtime

~> 2.7
 Project Readme

Quidax

Quidax Ruby Library

RSpec Test status

A ruby gem for easy integration of Quidax. Please kindly see the docs to get a sense of how the API behaves

Installation

Add this line to your application's Gemfile:

gem 'quidax'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install quidax

Usage

Instantiate a Quidax Object

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)

Using an object

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:

1. Accessing methods after initializing object instance

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

2. Accessing methods directly from the object

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, while body: is used for post/put requests with a payload

Quidax Objects

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

Development

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aremu-smog/quidax-ruby.

License

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