fuzionx-node-lib

1.0.0 • Public • Published

fuzionx-node-lib

Node.js library for FuzionX CEX.

This library is specifically for end users and traders to connect to FuzionX CEX.

Usage

const fuzionx = require('fuzionx-node-lib');

const client = new fuzionx();

You can pass the apiURL and baseURL of the FuzionX API you want to connect to, but it is connected to https://fuzionx.io/api/v2 by default. You can also pass your apiKey and apiSecret generated from our exchange.

const client = new fuzionx({
	apiURL: '<EXCHANGE_API_URL>',
	baseURL: '<EXCHANGE_BASE_URL>',
	apiKey: '<MY_API_KEY>',
	apiSecret: '<MY_API_SECRET>'
});

You can also pass the field apiExpiresAfter which is the length of time in seconds each request is valid for. The default value is 60.

Example:

const client = new fuzionx({
	apiURL: '<EXCHANGE_API_URL>',
	baseURL: '<EXCHANGE_BASE_URL>',
	apiKey: '<MY_API_KEY>',
	apiSecret: '<MY_API_SECRET>'
});

client
	.getTicker('btc-usdt')
	.then((res) => {
		console.log('The volume is: ', res.volume);
	})
	.catch((err) => {
		console.log(err);
	});

client
	.getTrades({ symbol: 'btc-usdt' })
	.then((res) => {
		console.log('Public trades: ', res);
	})
	.catch((err) => {
		console.log(err);
	});

Available functions:

Command Parameters Description
getKit Get exchange information e.g. name, valid languages, description, etc.
getConstants Tick size, min price, max price, min size and max size of each symbol pair and coin
getTicker
  • symbol: FuzionX trading symbol e.g. btc-usdt
Last, high, low, open and close price and volume within the last 24 hours
getTickers Last, high, low, open and close price and volume within the last 24 hours for all symbols
getOrderbook
  • symbol: FuzionX trading symbol e.g. btc-usdt
Orderbook containing list of bids and asks
getOrderbooks Orderbook containing list of bids and asks for all symbols
getTrades
  • opts: Object with additional params
  • opts.symbol: (optional) FuzionX trading symbol e.g. btc-usdt
List of last trades
getUser User's personal information
getBalance User's wallet balance
getDeposits
  • opts: Object with additional params
  • opts.currency: (optional) Filter data set by asset
  • opts.status: (optional) Filter data set status
  • opts.dismissed: (optional) Filter data set dismissed
  • opts.rejected: (optional) Filter data set rejected
  • opts.processing: (optional) Filter data set processing
  • opts.waiting: (optional) Filter data set waiting
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.transactionId: (optional) Filter data set by TXID
  • opts.address: (optional) Filter data set by address
User's list of all deposits
getWithdrawals
  • opts: Object with additional params
  • opts.currency: (optional) Filter data set by asset
  • opts.status: (optional) Filter data set status
  • opts.dismissed: (optional) Filter data set dismissed
  • opts.rejected: (optional) Filter data set rejected
  • opts.processing: (optional) Filter data set processing
  • opts.waiting: (optional) Filter data set waiting
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
  • opts.transactionId: (optional) Filter data set by TXID
  • opts.address: (optional) Filter data set by address
User's list of all withdrawals
makeWithdrawal
  • currency: Currency code e.g. xht
  • amount: Withdrawal amount
  • address: Address to withdrawal to
  • opts: Object with additional params
  • opts.network: (required if asset has multiple networks) Blockchain network to create address for e.g. trx
Create a new withdrawal request
getUserTrades
  • opts: Object with additional params
  • opts.symbol: (optional) FuzionX trading symbol e.g. btc-usdt
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc]) Specify ascending or descending order
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
User's list of all trades
getOrder
  • orderId: FuzionX Network Order ID
Get specific information about a certain order
getOrders
  • opts: Object with additional params
  • opts.symbol: (optional) FuzionX trading symbol e.g. btc-usdt
  • opts.side: (optional, enum=[buy, sell]) Order side
  • opts.status: (optional) Filter data set status
  • opts.limit: (optional, default=50, max=50) Number of items to get
  • opts.page: (optional, default=1) Page number of data
  • opts.orderBy: (optional) Field to order data by
  • opts.order: (optional, enum=[asc, desc])
  • opts.startDate: (optional, format=ISO8601) Start date of data set
  • opts.endDate: (optional, format=ISO8601) End date of data set
Get the list of all user orders. It can be filter by passing the symbol
createOrder
  • symbol: FuzionX trading symbol e.g. btc-usdt
  • side (enum=[buy, sell]): Order side
  • size: Size of order to place
  • type: (enum=[market, limit] Order type
  • price: (required if limit order type) Order price
  • opts: Object with additional params
  • opts.stop: (optional) Stop price for order
  • opts.meta: (optional) Object with additional meta configurations
  • opts.meta.post_only: (optional, default=false) Make post only order
  • opts.meta.note: (optional) Custom note for order
Create a new order
cancelOrder
  • orderId: FuzionX Network order ID
Cancel a specific order with its ID
cancelAllOrders
  • symbol: FuzionX trading symbol e.g. btc-usdt
Cancel all the active orders of a user, filtered by currency pair symbol

Websocket

Functions

You can connect and subscribe to different websocket channels for realtime updates.

To connect, use the connect function with the channels you want to subscribe to in an array as the parameter. The connection will reconnect on it's own unless you call disconnect.

client.connect(['orderbook', 'trade']);

To disconnect the websocket, call disconnect.

client.disconnect();

To subscribe to more channels after connection, use subscribe.

client.subscribe(['order', 'wallet']);

To unsubscribe from channels after connection, use unsubscribe.

client.unsubscribe(['orderbook']);

Channels

Here is the list of channels you can subscribe to:

  • orderbook
  • trades
  • order (Only available with authentication. Receive order updates)
  • wallet (Only available with authentication. Receive balance updates)

For public channels (orderbook, trade), you can subscribe to specific symbols as follows: orderbook:btc-usdt, trade:btc-usdt. Not passing a symbol will subscribe to all symbols.

Events

After connecting to the websocket, you can listen for events coming from the server by using the on function for the ws property of the client. The events available are default websocket events e.g. message, open, close, error, unexpected-response, etc.

client.ws.on('message', (data) => {
	data = JSON.parse(data);
	console.log(data);
});

These are exapmles of data responses from the server.

  • orderbook: Updates related to the user's private information are as follows:

     {
     	"topic": "orderbook",
     	"action": "partial",
     	"symbol": "btc-usdt",
     	"data": {
     		"bids": [
     			[0.1, 0.1],
     			...
     		],
     		"asks": [
     			[1, 1],
     			...
     		],
     		"timestamp": "2020-12-15T06:45:27.766Z"
     	},
     	"time": 1608015328
     }
  • trade: Updates related to the user's private information are as follows:

     {
     	"topic": "trade",
     	"action": "partial",
     	"symbol": "btc-usdt",
     	"data": [
     		{
     			"size": 0.012,
     			"price": 300,
     			"side": "buy",
     			"timestamp": "2020-12-15T07:25:28.887Z"
     		},
     		...
     	],
     	"time": 1608015328
     }
  • wallet: Updates related to the user's private information are as follows:

     {
     	"topic": "wallet",
     	"action": "partial",
     	"user_id": 1,
     	"data": {
     		"usdt_balance": 1,
     		"usdt_available": 1,
     		"xht_balance": 1,
     		"xht_available": 1,
     		"xmr_balance": 1,
     		"xmr_available": 1,
     		"btc_balance": 1,
     		"btc_available": 1,
     		"eth_balance": 1,
     		"eth_available": 1,
     		...,
     		"updated_at": "2020-12-15T08:41:24.048Z"
     	},
     	"time": 1608021684
     }
  • order: Websocket messages relating the the user's orders.

    • The status of the order can be new, pfilled, filled, and canceled.

    • The action of the data determines what caused it to happen. All three are explained below:

    • partial: All previous and current orders. Is the first order data received when connecting. Max: 50. Descending order.

      {
      	"topic": "order",
      	"action": "partial",
      	"user_id": 1,
      	"data": [
      		{
      			"id": "7d3d9545-b7e6-4e7f-84a0-a39efa4cb173",
      			"side": "buy",
      			"symbol": "btc-usdt",
      			"type": "limit",
      			"size": 0.1,
      			"filled": 0,
      			"price": 1,
      			"stop": null,
      			"status": "new",
      			"fee": 0,
      			"fee_coin": "btc",
      			"meta": {},
      			"fee_structure": {
      				"maker": 0.1,
      				"taker": 0.1
      			},
      			"created_at": "2020-11-30T07:45:43.819Z",
      			"created_by": 1
      		},
      		...
      	],
      	"time": 1608022610
      }
    • insert: When user's order is added. The status of the order can be either new, pfilled, or filled.

      {
      	"topic": "order",
      	"action": "insert",
      	"user_id": 1,
      	"symbol": "btc-usdt",
      	"data": [
      		{
      			"id": "7d3d9545-b7e6-4e7f-84a0-a39efa4cb173",
      			"side": "buy",
      			"symbol": "btc-usdt",
      			"type": "limit",
      			"size": 0.1,
      			"filled": 0,
      			"price": 1,
      			"stop": null,
      			"status": "new",
      			"fee": 0,
      			"fee_coin": "btc",
      			"meta": {},
      			"fee_structure": {
      				"maker": 0.1,
      				"taker": 0.1
      			},
      			"created_at": "2020-11-30T07:45:43.819Z",
      			"updated_at": "2020-12-15T08:56:45.066Z",
      			"created_by": 1
      		},
      		...
      	],
      	"time": 1608022610
      }
    • update: When user's order status is updated. Status can be pfilled, filled, and canceled.

      {
      	"topic": "order",
      	"action": "insert",
      	"user_id": 1,
      	"symbol": "btc-usdt",
      	"data": [
      		{
      			"id": "7d3d9545-b7e6-4e7f-84a0-a39efa4cb173",
      			"side": "buy",
      			"symbol": "btc-usdt",
      			"type": "limit",
      			"size": 0.1,
      			"filled": 0,
      			"price": 1,
      			"stop": null,
      			"status": "new",
      			"fee": 0,
      			"fee_coin": "btc",
      			"meta": {},
      			"fee_structure": {
      				"maker": 0.1,
      				"taker": 0.1
      			},
      			"created_at": "2020-11-30T07:45:43.819Z",
      			"updated_at": "2020-12-15T08:56:45.066Z",
      			"created_by": 1
      		},
      		...
      	],
      	"time": 1608022610
      }

Example

You can run the example by going to example folder and running:

node example/fuzion.js

Documentation

You can read more about api documentation at https://zenith-chain.github.io/fuzionxcex-apidoc You should create your token on the platform in setting->api keys

Readme

Keywords

none

Package Sidebar

Install

npm i fuzionx-node-lib

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

65.4 kB

Total Files

13

Last publish

Collaborators

  • imam_abubakar