Merge pull request #28 from JJ-Cro/update081124

chore(): Updated examples so each client matches the proper initialisation
tiagosiebler · Nov 11, 2024 · 9800670 · 9800670
2 parents e990ec7 + 27a599e
commit 9800670
Show file tree

Hide file tree

Showing 122 changed files with 366 additions and 244 deletions.
diff --git a/examples/apidoc/FuturesClientV2/cancelAllFuturesOrders.js b/examples/apidoc/FuturesClientV2/cancelAllFuturesOrders.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.cancelAllFuturesOrders(params)

diff --git a/examples/apidoc/FuturesClientV2/cancelFuturesOrder.js b/examples/apidoc/FuturesClientV2/cancelFuturesOrder.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.cancelFuturesOrder(params)

diff --git a/examples/apidoc/FuturesClientV2/cancelFuturesPlanOrder.js b/examples/apidoc/FuturesClientV2/cancelFuturesPlanOrder.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.cancelFuturesPlanOrder(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountAssets.js b/examples/apidoc/FuturesClientV2/getFuturesAccountAssets.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountAssets(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountOpenOrders.js b/examples/apidoc/FuturesClientV2/getFuturesAccountOpenOrders.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountOpenOrders(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountOrder.js b/examples/apidoc/FuturesClientV2/getFuturesAccountOrder.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountOrder(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountOrderHistory.js b/examples/apidoc/FuturesClientV2/getFuturesAccountOrderHistory.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountOrderHistory(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountPlanOrders.js b/examples/apidoc/FuturesClientV2/getFuturesAccountPlanOrders.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountPlanOrders(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountPositions.js b/examples/apidoc/FuturesClientV2/getFuturesAccountPositions.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountPositions(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAccountTrades.js b/examples/apidoc/FuturesClientV2/getFuturesAccountTrades.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAccountTrades(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAffiliateRebates.js b/examples/apidoc/FuturesClientV2/getFuturesAffiliateRebates.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAffiliateRebates(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesAffiliateTrades.js b/examples/apidoc/FuturesClientV2/getFuturesAffiliateTrades.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesAffiliateTrades(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesContractDepth.js b/examples/apidoc/FuturesClientV2/getFuturesContractDepth.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesContractDepth(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesContractDetails.js b/examples/apidoc/FuturesClientV2/getFuturesContractDetails.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesContractDetails(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesFundingRate.js b/examples/apidoc/FuturesClientV2/getFuturesFundingRate.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesFundingRate(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesKlines.js b/examples/apidoc/FuturesClientV2/getFuturesKlines.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesKlines(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesOpenInterest.js b/examples/apidoc/FuturesClientV2/getFuturesOpenInterest.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesOpenInterest(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesSubTransferHistory.js b/examples/apidoc/FuturesClientV2/getFuturesSubTransferHistory.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesSubTransferHistory(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesSubTransfers.js b/examples/apidoc/FuturesClientV2/getFuturesSubTransfers.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesSubTransfers(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesSubWallet.js b/examples/apidoc/FuturesClientV2/getFuturesSubWallet.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesSubWallet(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesTradeFeeRate.js b/examples/apidoc/FuturesClientV2/getFuturesTradeFeeRate.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesTradeFeeRate(params)

diff --git a/examples/apidoc/FuturesClientV2/getFuturesTransfers.js b/examples/apidoc/FuturesClientV2/getFuturesTransfers.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getFuturesTransfers(params)

diff --git a/examples/apidoc/FuturesClientV2/getPositionRiskDetails.js b/examples/apidoc/FuturesClientV2/getPositionRiskDetails.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getPositionRiskDetails(params)

diff --git a/examples/apidoc/FuturesClientV2/getSystemStatus.js b/examples/apidoc/FuturesClientV2/getSystemStatus.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getSystemStatus(params)

diff --git a/examples/apidoc/FuturesClientV2/getSystemTime.js b/examples/apidoc/FuturesClientV2/getSystemTime.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: YES
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.getSystemTime(params)

diff --git a/examples/apidoc/FuturesClientV2/setFuturesLeverage.js b/examples/apidoc/FuturesClientV2/setFuturesLeverage.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.setFuturesLeverage(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesMainToSubTransferFromMain.js b/examples/apidoc/FuturesClientV2/submitFuturesMainToSubTransferFromMain.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesMainToSubTransferFromMain(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesOrder.js b/examples/apidoc/FuturesClientV2/submitFuturesOrder.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesOrder(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesPlanOrder.js b/examples/apidoc/FuturesClientV2/submitFuturesPlanOrder.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesPlanOrder(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesSubToMainSubFromSub.js b/examples/apidoc/FuturesClientV2/submitFuturesSubToMainSubFromSub.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesSubToMainSubFromSub(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesSubToMainTransferFromMain.js b/examples/apidoc/FuturesClientV2/submitFuturesSubToMainTransferFromMain.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesSubToMainTransferFromMain(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesTPSLOrder.js b/examples/apidoc/FuturesClientV2/submitFuturesTPSLOrder.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesTPSLOrder(params)

diff --git a/examples/apidoc/FuturesClientV2/submitFuturesTransfer.js b/examples/apidoc/FuturesClientV2/submitFuturesTransfer.js
@@ -7,8 +7,9 @@ const { FuturesClientV2 } = require('bitmart-api');
   // PUBLIC: NO
 
 const client = new FuturesClientV2({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+  apiKey: 'yourAPIKeyHere',
+  apiSecret: 'yourAPISecretHere',
+  apiMemo: 'yourAPIMemoHere',
 });
 
 client.submitFuturesTransfer(params)