# exir-node-lib > EXIR api and websocket library for nodejs Latest version **1.0.1** (published 2025-09-28) · MIT license · 0 weekly downloads ## Install ```sh npm install exir-node-lib pnpm add exir-node-lib yarn add exir-node-lib bun add exir-node-lib ``` ## Health **Score 45/100 (D)** — status: stable. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. ## Facts | | | |---|---| | Version | 1.0.1 | | Published | 2025-09-28 | | First published | 2019-03-08 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 8 | | Unpacked size | 46.5 KB | | Known vulnerabilities | 0 (+14 in 5 direct dependencies) | | Install scripts | no | | Maintainers | exir-tech | ## Links - npm: https://www.npmjs.com/package/exir-node-lib - Repository: https://gitlab.com/exirorg/exir-node-lib - Homepage: https://gitlab.com/exirorg/exir-node-lib#readme - Issues: https://gitlab.com/exirorg/exir-node-lib/issues - npm.io page: https://npm.io/package/exir-node-lib ## Dependencies (8) - [ws](https://npm.io/package/ws.md) 7.4.0 - [lodash](https://npm.io/package/lodash.md) 4.17.13 - [moment](https://npm.io/package/moment.md) 2.24.0 - [request](https://npm.io/package/request.md) 2.88.0 - [file-type](https://npm.io/package/file-type.md) 16.5.2 - [is-base64](https://npm.io/package/is-base64.md) 1.1.0 - [ws-heartbeat](https://npm.io/package/ws-heartbeat.md) 1.1.0 - [request-promise](https://npm.io/package/request-promise.md) 4.2.2 ## Recent versions - 1.0.1 (latest) — 2025-09-28 - 1.0.0 — 2025-09-28 - 0.3.2 — 2019-03-08 ## README # exir-node-lib Nodejs library for EXIR.io exchange. **This library is specifically for end users and traders to connect to pro.exir.io exchange. It connects to [EXIR.io](https://pro.exir.io) by default.** ## Usage ```javascript const exir = require('exir-node-lib'); const client = new exir(); ``` `baseURL` is set to default to `/v2` unless you need to connect to an older version of EXIR. To use private requests that require authentication, you should pass your `apiKey` and `apiSecret` generated from the Security page in your user account. 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: ```javascript const client = new exir({ apiKey: '', apiSecret: '' }); 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 | | - | - | - | | `getTicker` | | 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` | | Orderbook containing list of bids and asks | | `getOrderbooks` | | Orderbook containing list of bids and asks for all symbols | | `getTrades` | | List of last trades | | `getUser` | | User's personal information | | `getBalance` | | User's wallet balance | | `getDeposits` | | User's list of all deposits | | `getWithdrawals` | | User's list of all withdrawals | | `makeWithdrawal` | | Create a new withdrawal request | | `getUserTrades` | | User's list of all trades | | `getOrder` | | Get specific information about a certain order | | `getOrders` | | Get the list of all user orders. It can be filter by passing the symbol | | `createOrder` | | Create a new order | | `cancelOrder` | | Cancel a specific order with its ID | | `cancelAllOrders` | | Cancel all the active orders of a user, filtered by currency pair symbol | | `getMiniCharts` | | Get trade history HOLCV for all pairs | | `getQuickTradeQuote` | | Get Quick Trade Quote | | `executeOrder` | | Execute Order | ### 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`. ```javascript client.connect(['orderbook', 'trade']); ``` To disconnect the websocket, call `disconnect`. ```javascript client.disconnect(); ``` To subscribe to more channels after connection, use `subscribe`. ```javascript client.subscribe(['order', 'wallet']); ``` To unsubscribe from channels after connection, use `unsubscribe`. ```javascript client.unsubscribe(['orderbook']); ``` #### Channels Here is the list of channels you can subscribe to: - `orderbook` (Available publicly) - `trade` (Available publicly) - `order` (Only available with authentication. Receive order updates) - `usertrade` (Only available with authentication. Receive user trades) - `wallet` (Only available with authentication. Receive balance updates) - `deposit` (Only available with authentication. Receive deposit notifications) - `withdrawal` (Only available with authentication. Receive withdrawal notifications) 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. ```javascript 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: ```json { "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: ```json { "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: ```json { "topic": "wallet", "action": "partial", "user_id": 1, "data": { "usdt_balance": 1, "usdt_available": 1, "btc_balance": 1, "btc_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. ```json { "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`. ```json { "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`. ```json { "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 } ``` - **deposit**: Updates related to the user's private information are as follows: ```json { "topic": "deposit", "action": "insert", "user_id": 1, "data": { "amount": 1, "currency": "btc", "status": "COMPLETED", "transaction_id": "123", ... }, "time": 1608021684 } ``` - **withdrawal**: Updates related to the user's private information are as follows: ```json { "topic": "withdrawal", "action": "insert", "user_id": 1, "data": { "amount": 1, "currency": "btc", "status": "COMPLETED", "transaction_id": "123", ... }, "time": 1608021684 } ``` ## Example You can run the example by going to example folder and running: ```bash node example/exir.js ``` ## Documentation For adding additional functionalities simply go to index.js and add more features. You can read more about api documentation at https://apidocs.exir.com You should create your token on the platform in security->Api Key keys --- _Source: https://npm.io/package/exir-node-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._