Merge pull request #401 from JJ-Cro/Update06012025

v3.10.28 feat(): added new endpoints, updated examples

examples/apidoc/V5/Account/get-transferable-amount-unified.js

@@ -0,0 +1,18 @@
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+    testnet: true,
+    key: 'apikey',
+    secret: 'apisecret',
+});
+
+client
+    .getTransferableAmount({
+        coinName: 'USDT',
+    })
+    .then((response) => {
+        console.log(response);
+    })
+    .catch((error) => {
+        console.error(error);
+    });

examples/apidoc/V5/Affiliate/get-affiliate-user-info.js

@@ -0,0 +1,18 @@
+// https://api.bybit.com/v5/broker/account-info
+
+const { RestClientV5 } = require('bybit-api');
+
+const client = new RestClientV5({
+  testnet: true,
+  key: 'apikey',
+  secret: 'apisecret',
+});
+
+client
+  .getAffiliateUserInfo({ uid: '1234567890' })
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/V5/Affiliate/get-affiliate-user-list.js

@@ -1,3 +1,5 @@
+// https://api.bybit.com/v5/broker/account-info
+
 const { RestClientV5 } = require('bybit-api');
 
 const client = new RestClientV5({
@@ -7,7 +9,7 @@ const client = new RestClientV5({
 });
 
 client
-  .getAffiliateUserInfo({ uid: '1513500' })
+  .getAffiliateUserList()
   .then((response) => {
     console.log(response);
   })

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "bybit-api",
-  "version": "3.10.27",
+  "version": "3.10.28",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "bybit-api",
-      "version": "3.10.27",
+      "version": "3.10.28",
       "license": "MIT",
       "dependencies": {
         "axios": "^1.6.6",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bybit-api",
-  "version": "3.10.27",
+  "version": "3.10.28",
   "description": "Complete & robust Node.js SDK for Bybit's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/rest-client-v5.ts

@@ -12,6 +12,7 @@ import {
   AddOrReduceMarginParamsV5,
   AddOrReduceMarginResultV5,
   AffiliateUserInfoV5,
+  AffiliateUserListItemV5,
   AllCoinsBalanceV5,
   AllowedDepositCoinInfoV5,
   AmendOrderParamsV5,
@@ -995,6 +996,19 @@ export class RestClientV5 extends BaseRestClient {
     return this.getPrivate('/v5/account/wallet-balance', params);
   }
 
+  /**
+   * Query the available amount to transfer of a specific coin in the Unified wallet.
+   *
+   * @param coinName Coin name, uppercase only
+   */
+  getTransferableAmount(params: { coinName: string }): Promise<
+    APIResponseV3WithTime<{
+      availableWithdrawal: string;
+    }>
+  > {
+    return this.getPrivate('/v5/account/withdrawal', params);
+  }
+
   /**
    * Upgrade to unified account.
    *
@@ -1782,6 +1796,29 @@ export class RestClientV5 extends BaseRestClient {
     return this.postPrivate('/v5/user/del-submember', params);
   }
 
+  /**
+   *
+   ****** Affiliate APIs
+   *
+   */
+
+  /**
+   * Get Affiliate User List.
+   * To use this endpoint, you should have an affiliate account and only tick "affiliate" permission while creating the API key.
+   *
+   * TIP:
+   * - Use master UID only
+   * - The api key can only have "Affiliate" permission
+   */
+  getAffiliateUserList(params?: { size?: number; cursor?: string }): Promise<
+    APIResponseV3WithTime<{
+      list: AffiliateUserListItemV5[];
+      nextPageCursor: string;
+    }>
+  > {
+    return this.getPrivate('/v5/affiliate/aff-user-list', params);
+  }
+
   /**
    * Get Affiliate User Info.
    *

src/types/response/v5-user.ts

@@ -78,6 +78,14 @@ export interface SubAccountAllApiKeysResultV5 {
   nextPageCursor: string;
 }
 
+export interface AffiliateUserListItemV5 {
+  userId: string;
+  registerTime: string;
+  source: string;
+  remarks: string;
+  isKyc: boolean;
+}
+
 export interface AffiliateUserInfoV5 {
   uid: string;
   vipLevel: string;