quidax-node v1.1.4

Quidax Node Library

The Quidax Node library provides an easy access to the Quidax Developer API by Quidax.

Installation

Install node-client with npm

  npm i quidax-node

Documentation

See the Quidax API docs.

User: The Subaccounts API allows you create and manage subaccounts on your integration. Subaccounts can be used to generate crypto currency address, collect payments and track transaction status.

Creates sub user

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.users.create({ 
    email: 'test@gmail.com', 
    first_name: 'test', 
    last_name: 'user' ,
    phone_number: '08012345678'
})

Fetch all sub account

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.users.getAllSubAccounts()

Fetch user details

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.users.getAccountDetails('<user_id>')

Edit sub account

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.users.editAccount('<user_id>',{ 
    email: 'test@gmail.com', 
    first_name: 'test', 
    last_name: 'user' ,
    phone_number: '08012345678'
})

Markets: Fetch market data.

List all the markets

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.markets.listAllMarkets()

List all market tickers

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.markets.listMarketTickers()

Fetch a market ticker.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.markets.fetchMarketTicker('btcngn')

Fetch orderbook items market.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.markets.fetchOrderBookItemsForAMarket('btcngn', 5, 5)

Fetch market ticker depth.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.markets.fetchMarketTickerDepth('btcngn', 5)

Fetch k line data pending trades.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.markets.fetchKLineDataWithPendingTradesForAMarket('btcngn', 5, 10, "<timestamp>")

Wallets: Create wallets for user or sub-users.

Fetch all user wallets

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.wallets.fetchAllWallets('<user_id>')

Fetches currency wallet.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.wallets.fetchCurrencyWallet('<user_id>', 'btc')

Fetch payment addresses related to the wallet

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.wallets.fetchPaymentAddresses('<user_id>', 'btc')

Fetch payment address for a wallet.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.wallets.fetchPaymentAddress('<user_id>', 'btc')

Create payment address for a customer

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.wallets.createPaymentAddress('<user_id>', 'btc')

Fetch payment address by id.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.wallets.fetchPaymentAddressById('<user_id>', 'btc', '<address_id>')

Trade: Fetch trades of an asset.

Fetch trades of user.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.trade.trades('<user_id>')

Fetch recent trades for a given market pair.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.trade.fetchRecentTradesForMarketPair('btcngn')

Orders: Place trades on the orderbook.

Fetch orders of user.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.orders.getAllOrders('me', 'btcngn', 'accepted', 'desc')

Fetch order details.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.orders.getOrderDetails('<account_id>', '<order_id>')

Create a buy or sell order.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const payload = {
    market: "btcngn",
    side: "buy",
    ord_type: "limit",
    price: "1",
    volume: "0.1"
}

const data = quidax.orders.createBuyOrSellOrder(
    '<account_id>', 
    payload
)

Cancel order.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.orders.cancelOrder('<account_id>', '<order_id>')

Deposits: This endpoint is used to fetch endpoints

Fetch orders of user.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.deposit.fetchAllDeposit('<account_id>', 'btc', 'accepted')

Fetch an order of user.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.deposit.fetchDeposit('<account_id>', '<deposit_id>')

InstantOrder: This endpoint is used to buy and sell crypto for an authenticated user.

Fetch all instantOrder of a user, filtered by user_id.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.fetchAllInstantOrders('<account_id>', 'btcngn', 'done', 'desc')

Fetch detail instantOrder of user.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.fetchInstantOrdersDetail('<account_id>', '<instantOrder_id>')

Requotes an instant order.

const Quidax = require('quidax-node')
 
const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.requoteInstantOrder('<account_id>', '<instantOrder_id>')

Confirm an instant order.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.confirmInstantOrder('<account_id>', '<instantOrder_id>')

Create an instant order(buy crypto from fiat).

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.createInstantOrder('<account_id>', {
    "bid": "ngn",
    "ask": "btc",
    "type": "buy",
    "total": "5",
    "unit": "ngn"
})

Create an instant order(sell crypto to fiat).

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.createInstantOrder('<account_id>', {
    "bid": "usdt",
    "ask": "bnb",
    "type": "buy",
    "volume": "0.2",
    "unit": "usdt"
})

Create an instant order(buy a fixed number of the asset, regardless of the price.).

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

const data = quidax.instantOrder.createInstantOrder('<account_id>', {
    "bid": "ngn",
    "ask": "btc",
    "type": "buy",
    "volume": "5",
    "unit": "btc"
}})

Quotes: This endpoint is useed to get current price of an asset.

const Quidax = require('quidax-node')

const quidax = new Quidax(secretKey)

// Get an estimate how much btc can be bought with the stipulated price.
const data1 = quidax.quotes.quote({ 
    market: "btcngn",
    unit: "ngn", 
    kind: "bid", 
    total: 2 
})

// Get an estimate how much it would cost to buy btc with ngn.
const data2 = quidax.quotes.quote({ 
    market: "btcngn", 
    unit: "btc", 
    kind: "bid", 
    volume: 2 
})