Merge pull request #465 from JJ-Cro/TestRegex

feat(): updated examples
tiagosiebler · Oct 16, 2024 · 4d60b85 · 4d60b85
2 parents b7a7725 + 8780a25
commit 4d60b85
Show file tree

Hide file tree

Showing 579 changed files with 2,335 additions and 1,181 deletions.
diff --git a/docs/endpointFunctionList.md b/docs/endpointFunctionList.md
@@ -328,17 +328,17 @@ This table includes all endpoints from the official Exchange API docs and corres
 | [getCryptoLoanBorrowHistory()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2736) | :closed_lock_with_key:  | GET | `sapi/v1/loan/borrow/history` |
 | [getCryptoLoanLTVAdjustmentHistory()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2743) | :closed_lock_with_key:  | GET | `sapi/v1/loan/ltv/adjustment/history` |
 | [getCryptoLoanRepaymentHistory()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2752) | :closed_lock_with_key:  | GET | `sapi/v1/loan/repay/history` |
-| [getSimpleEarnAccount()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2764) | :closed_lock_with_key:  | GET | `/sapi/v1/simple-earn/account` |
-| [getFlexibleSavingProducts()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2768) | :closed_lock_with_key:  | GET | `/sapi/v1/simple-earn/flexible/list` |
-| [getSimpleEarnLockedProductList()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2775) | :closed_lock_with_key:  | GET | `/sapi/v1/simple-earn/locked/list` |
-| [getFlexibleProductPosition()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2784) | :closed_lock_with_key:  | GET | `/sapi/v1/simple-earn/flexible/position` |
-| [getLockedProductPosition()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2793) | :closed_lock_with_key:  | GET | `/sapi/v1/simple-earn/locked/position` |
+| [getSimpleEarnAccount()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2764) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/account` |
+| [getFlexibleSavingProducts()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2768) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/flexible/list` |
+| [getSimpleEarnLockedProductList()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2775) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/locked/list` |
+| [getFlexibleProductPosition()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2784) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/flexible/position` |
+| [getLockedProductPosition()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2793) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/locked/position` |
 | [getFlexiblePersonalLeftQuota()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2802) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/flexible/personalLeftQuota` |
 | [getLockedPersonalLeftQuota()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2811) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/locked/personalLeftQuota` |
-| [purchaseFlexibleProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2826) | :closed_lock_with_key:  | POST | `/sapi/v1/simple-earn/flexible/subscribe` |
-| [subscribeSimpleEarnLockedProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2832) | :closed_lock_with_key:  | POST | `/sapi/v1/simple-earn/locked/subscribe` |
-| [redeemFlexibleProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2838) | :closed_lock_with_key:  | POST | `/sapi/v1/simple-earn/flexible/redeem` |
-| [redeemLockedProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2844) | :closed_lock_with_key:  | POST | `/sapi/v1/simple-earn/locked/redeem` |
+| [purchaseFlexibleProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2826) | :closed_lock_with_key:  | POST | `sapi/v1/simple-earn/flexible/subscribe` |
+| [subscribeSimpleEarnLockedProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2832) | :closed_lock_with_key:  | POST | `sapi/v1/simple-earn/locked/subscribe` |
+| [redeemFlexibleProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2838) | :closed_lock_with_key:  | POST | `sapi/v1/simple-earn/flexible/redeem` |
+| [redeemLockedProduct()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2844) | :closed_lock_with_key:  | POST | `sapi/v1/simple-earn/locked/redeem` |
 | [setFlexibleAutoSubscribe()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2850) | :closed_lock_with_key:  | POST | `sapi/v1/simple-earn/flexible/setAutoSubscribe` |
 | [setLockedAutoSubscribe()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2859) | :closed_lock_with_key:  | POST | `sapi/v1/simple-earn/locked/setAutoSubscribe` |
 | [getFlexibleSubscriptionPreview()](https://github.com/tiagosiebler/binance/blob/master/src/main-client.ts#L2868) | :closed_lock_with_key:  | GET | `sapi/v1/simple-earn/flexible/subscriptionPreview` |

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);
   });