> For the complete documentation index, see [llms.txt](https://docs.bytex.ca/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bytex.ca/api-documentation/nodejs-library.md). # Nodejs Library ## Requirements * Knowledge of basic usage of Nodejs and npm * Nodejs version >= 12 * Install [hollaex-node-lib](https://www.npmjs.com/package/hollaex-node-lib) by running `npm i hollaex-node-lib` or `yarn add hollaex-node-lib` in your project ## Usage Using the Hollaex Kit Nodejs Library, the following guide is modified to communicate with the ByteX Exchange. ### Import Library ```javascript const kit = require('hollaex-node-lib'); const client = new kit({ apiURL: 'https://api.bytex.ca', baseURL: '/v2', apiKey: '', apiSecret: '' }); ``` Put your **API Key** for `` & **API Secret** for `` in the above code that you can generate from [the guide.](/api-documentation.md#generate-your-api-key) ### Making Requests ```javascript // // Initialize Client using above example... client .getTicker('usdt-cad') .then((res) => { console.log('The volume is: ', res.volume); }) .catch((err) => { console.log(err); }); client .getTrade({ symbol: 'usdt-cad' }) .then((res) => { console.log('Public trades: ', res); }) .catch((err) => { console.log(err); });A ``` ### Available Functions
CommandParametersDescription
getKitGet exchange information e.g. name, valid languages, description, etc.
getConstantsTick size, min price, max price, min size and max size of each symbol pair and coin
getTickersymbolLast, high, low, open and close price and volume within the last 24 hours
getTickersLast, high, low, open and close price and volume within the last 24 hours for all symbols
getOrderbooksymbolOrderbook containing list of bids and asks
getOrderbooksOrderbook containing list of bids and asks for all symbols
getTradesymbol (optional)List of last trades
getUserUser’s personal information
getBalanceUser’s wallet balance
getDepositscurrency (optional), limit (optional, default=50, max=100), page (optional, default=1), orderBy (optional, default=id), order (optional, default=asc, asc or desc), startDate (optional, default=0, format=ISO8601), endDate (optional, default=NOW, format=ISO8601)

User’s list of all deposits
getWithdrawalscurrency (optional), limit (optional, default=50, max=100), page (optional, default=1), orderBy (optional, default=id), order (optional, default=asc, asc or desc), startDate (optional, default=0, format=ISO8601), endDate (optional, default=NOW, format=ISO8601)User’s list of all withdrawals
requestWithdrawalcurrency, amount, address (receipient’s)Create a new withdrawal request. Disable Two-Factor Authentication to be able to use this function. Must confirm within 5 minutes via email to complete withdrawal
getUserTradessymbol (optional), limit (optional, default=50, max=100), page (optional, default=1), orderBy (optional, default=id), order (optional, default=desc, asc or desc), startDate (optional, default=0, format=ISO8601), endDate (optional, default=NOW, format=ISO8601)User’s list of all trades
getOrderorderIdGet specific information about a certain order
getOrderssymbol (optional), limit (optional, default=50, max=100), page (optional, default=1), orderBy (optional, default=id), order (optional, default=desc, enum=asc, desc), startDate (optional, default=0, format=ISO8601), endDate (optional, default=NOW, format=ISO8601)

Get the list of all user orders. It can be filter by passing the symbol
createOrdersymbol, side (buy or sell), size, type (market or limit), price, stop (optional), meta (optional, object with optional properties e.g. post_only)Create a new order
cancelOrderorderIdCancel a specific order with its ID
cancelAllOrderssymbol (optional)Cancel all open order. It can be filter by passing the symbol
{% hint style="info" %} ByteX Exchange is an Hollaex Kit Enabled Exchange, so you can learn more information on API usage, instructions & examples from their [Github Repo](https://github.com/bitholla/hollaex-node-lib/tree/2.0). {% endhint %} ## Websocket Client > This guide uses `hollaex-node-lib` and assumes that you have already configured your code to assign `client` variable/constant (as shown above) before trying this. To make a connection: ```javascript var new_connetion = client.connect(['orderbook', 'trade']); ``` To disconnect: ```javascript new_connetion.disconnect(); ``` ### Channel Subscriptions * orderbook * trades * order (Only available with authentication. Receive order updates) * wallet (Only available with authentication. Receive balance updates) ### Listen to events After connection, You can listen for these events from the server by using the on method: * message * open * close * error * unexpected-response etc. #### **Example** ```javascript // Initialize Client using above example... const socket1 = client.connect('trades:usdt-cad'); socket1.on('trades', (data) => { console.log(data); }); const socket2 = client.connect('all'); socket2.on('orderbook', (data) => { console.log(data); }); // You have to use a token to use these otherwise the socket disconnects socket2.on('userInfo', (data) => { console.log(data); }); setTimeout(() => { socket2.disconnect(); }, 5); ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.bytex.ca/api-documentation/nodejs-library.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.