feat(): updated examples

JJ-Cro · Oct 16, 2024 · 69ae911 · 69ae911
1 parent 2c8d23f
commit 69ae911
Show file tree

Hide file tree

Showing 577 changed files with 2,308 additions and 1,154 deletions.
diff --git a/examples/apidoc/CoinMClient/cancelAllOpenOrders.js b/examples/apidoc/CoinMClient/cancelAllOpenOrders.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/allOpenOrders
   // METHOD: DELETE
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.cancelAllOpenOrders(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/cancelMultipleOrders.js b/examples/apidoc/CoinMClient/cancelMultipleOrders.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/batchOrders
   // METHOD: DELETE
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.cancelMultipleOrders(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/cancelOrder.js b/examples/apidoc/CoinMClient/cancelOrder.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/order
   // METHOD: DELETE
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.cancelOrder(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/closeFuturesUserDataListenKey.js b/examples/apidoc/CoinMClient/closeFuturesUserDataListenKey.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/listenKey
   // METHOD: DELETE
   // PUBLIC: YES
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.closeFuturesUserDataListenKey(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/get24hrChangeStatistics.js b/examples/apidoc/CoinMClient/get24hrChangeStatistics.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/ticker/24hr
   // METHOD: GET
   // PUBLIC: YES
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.get24hrChangeStatistics(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/get24hrChangeStatististics.js b/examples/apidoc/CoinMClient/get24hrChangeStatististics.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/ticker/24hr
   // METHOD: GET
   // PUBLIC: YES
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.get24hrChangeStatististics(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getADLQuantileEstimation.js b/examples/apidoc/CoinMClient/getADLQuantileEstimation.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/adlQuantile
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getADLQuantileEstimation(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getAccountComissionRate.js b/examples/apidoc/CoinMClient/getAccountComissionRate.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/commissionRate
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getAccountComissionRate(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getAccountInformation.js b/examples/apidoc/CoinMClient/getAccountInformation.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/account
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getAccountInformation(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getAccountTrades.js b/examples/apidoc/CoinMClient/getAccountTrades.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/userTrades
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getAccountTrades(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getAggregateTrades.js b/examples/apidoc/CoinMClient/getAggregateTrades.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/aggTrades
   // METHOD: GET
   // PUBLIC: YES
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getAggregateTrades(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getAllOpenOrders.js b/examples/apidoc/CoinMClient/getAllOpenOrders.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/openOrders
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getAllOpenOrders(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getAllOrders.js b/examples/apidoc/CoinMClient/getAllOrders.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/allOrders
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getAllOrders(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBalance.js b/examples/apidoc/CoinMClient/getBalance.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/balance
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBalance(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBrokerClientCustomIds.js b/examples/apidoc/CoinMClient/getBrokerClientCustomIds.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/apiReferral/customization
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBrokerClientCustomIds(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBrokerIfNewFuturesUser.js b/examples/apidoc/CoinMClient/getBrokerIfNewFuturesUser.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/apiReferral/ifNewUser
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBrokerIfNewFuturesUser(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBrokerRebateDataOverview.js b/examples/apidoc/CoinMClient/getBrokerRebateDataOverview.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/apiReferral/overview
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBrokerRebateDataOverview(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBrokerRebateVolume.js b/examples/apidoc/CoinMClient/getBrokerRebateVolume.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/apiReferral/rebateVol
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBrokerRebateVolume(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBrokerTradeDetail.js b/examples/apidoc/CoinMClient/getBrokerTradeDetail.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/apiReferral/traderSummary
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBrokerTradeDetail(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });
diff --git a/examples/apidoc/CoinMClient/getBrokerUserCustomId.js b/examples/apidoc/CoinMClient/getBrokerUserCustomId.js
@@ -1,5 +1,7 @@
 const { CoinMClient } = require('binance');
 
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
   // ENDPOINT: dapi/v1/apiReferral/userCustomization
   // METHOD: GET
   // PUBLIC: NO
@@ -11,9 +13,9 @@ const client = new CoinMClient({
 });
 
 client.getBrokerUserCustomId(params)
-  .then(response => {
+  .then((response) => {
     console.log(response);
   })
-  .catch(error => {
+  .catch((error) => {
     console.error(error);
   });