> For the complete documentation index, see [llms.txt](https://cayc.gitbook.io/cayc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cayc.gitbook.io/cayc/cayc-exchange/cayc-exchange-documentation-home/api-documentation/using-nodejs-library.md). # Using Nodejs Library Connect with CAYC Exchange using Hollaex kit 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 > Connecting with any Hollaex Kit Enabled Exchange is pretty much same, with minor modifications you can connect to all the exchanges that uses similar Hollaex Kit backends. #### Import Library ```js const kit = require('hollaex-node-lib'); const client = new kit({ apiURL: 'https://api.cayc.exchange', baseURL: '/v2', apiKey: '', apiSecret: '' }); ``` Put **Api Key** for `` & **Api Secret** for `` in above code that you can get from [the guide](https://docs.cayc.exchange/docs/api_docs/introduction/#how-to-create-an-api-key). #### Request structure ```js // Initialize Client using above example... client .getTicker('xht-usdt') .then((res) => { console.log('The volume is: ', res.volume); }) .catch((err) => { console.log(err); }); client .getTrade({ symbol: 'xht-usdt' }) .then((res) => { console.log('Public trades: ', res); }) .catch((err) => { console.log(err); }); ``` #### Available methods * **Optional parameters are all contained within an object parameter called `opts`** | 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** |

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** |

Orderbook containing list of bids and asks

| | `getOrderbooks` | |

Orderbook containing list of bids and asks for all symbols

| | `getTrade` | **symbol** (*optional*) | List of last trades | | `getUser` | | User’s personal information | | `getBalance` | | User’s wallet balance | | `getDeposits` |

currency (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 | | `getWithdrawals` | **currency** (*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 | | `requestWithdrawal` | **currency**, **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** | | `getUserTrades` | **symbol** (*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 | | `getOrder` | **orderId** | Get specific information about a certain order | | `getOrders` |

symbol (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 | | `createOrder` | **symbol**, **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 | | `cancelOrder` | **orderId** | Cancel a specific order with its ID | | `cancelAllOrders` | **symbol** (*optional*) | Cancel all open order. It can be filter by passing the symbol | |



| | | > CAYC Exchange is based on the Hollaex Kit Enabled Exchange so you can read about more for API usage, instructions & examples from [Github Repo](https://github.com/bitholla/hollaex-node-lib/tree/2.0)\ > \
### Websocket client > To create custom websocket client, Please visit [the guide](https://docs.cayc.exchange/docs/api_docs/custom_ws.md), 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: ```js var new_connetion = client.connect(['orderbook', 'trade']); ``` To disconnect it: ```js new_connetion.disconnect(); ``` #### Channel subscriptions You can subscribe to following channels * 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 on method, e.g. * message * open * close * error * unexpected-response etc. **Example** ```js // Initialize Client using above example... const socket1 = client.connect('trades:xht-usdt'); 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); ``` ### Resources * Node Library Usage instructions: * Using Websockets from node library to connect: * Create custom websocket client: