Merge pull request #77 from JJ-Cro/update081124

chore(): Updated examples
tiagosiebler · Nov 11, 2024 · 807e030 · 807e030
2 parents 05ee475 + bf868c3
commit 807e030
Show file tree

Hide file tree

Showing 342 changed files with 1,026 additions and 684 deletions.
diff --git a/examples/apidoc/RestClient/activateOption.js b/examples/apidoc/RestClient/activateOption.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.activateOption(params)

diff --git a/examples/apidoc/RestClient/adjustGridInvestment.js b/examples/apidoc/RestClient/adjustGridInvestment.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.adjustGridInvestment(params)

diff --git a/examples/apidoc/RestClient/adjustGridMarginBalance.js b/examples/apidoc/RestClient/adjustGridMarginBalance.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.adjustGridMarginBalance(params)

diff --git a/examples/apidoc/RestClient/amendAlgoOrder.js b/examples/apidoc/RestClient/amendAlgoOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.amendAlgoOrder(params)

diff --git a/examples/apidoc/RestClient/amendGridAlgoOrder.js b/examples/apidoc/RestClient/amendGridAlgoOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.amendGridAlgoOrder(params)

diff --git a/examples/apidoc/RestClient/amendLendingOrder.js b/examples/apidoc/RestClient/amendLendingOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.amendLendingOrder(params)

diff --git a/examples/apidoc/RestClient/amendMultipleOrders.js b/examples/apidoc/RestClient/amendMultipleOrders.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.amendMultipleOrders(params)

diff --git a/examples/apidoc/RestClient/amendOrder.js b/examples/apidoc/RestClient/amendOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.amendOrder(params)

diff --git a/examples/apidoc/RestClient/amendRecurringBuyOrder.js b/examples/apidoc/RestClient/amendRecurringBuyOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.amendRecurringBuyOrder(params)

diff --git a/examples/apidoc/RestClient/applyCopytradingLeadTrading.js b/examples/apidoc/RestClient/applyCopytradingLeadTrading.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.applyCopytradingLeadTrading(params)

diff --git a/examples/apidoc/RestClient/applyForMonthlyStatement.js b/examples/apidoc/RestClient/applyForMonthlyStatement.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.applyForMonthlyStatement(params)

diff --git a/examples/apidoc/RestClient/borrowRepayVIPLoan.js b/examples/apidoc/RestClient/borrowRepayVIPLoan.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.borrowRepayVIPLoan(params)

diff --git a/examples/apidoc/RestClient/cancelAdvanceAlgoOrder.js b/examples/apidoc/RestClient/cancelAdvanceAlgoOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAdvanceAlgoOrder(params)

diff --git a/examples/apidoc/RestClient/cancelAlgoOrder.js b/examples/apidoc/RestClient/cancelAlgoOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAlgoOrder(params)

diff --git a/examples/apidoc/RestClient/cancelAllAfter.js b/examples/apidoc/RestClient/cancelAllAfter.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAllAfter(params)

diff --git a/examples/apidoc/RestClient/cancelAllBlockAfter.js b/examples/apidoc/RestClient/cancelAllBlockAfter.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAllBlockAfter(params)

diff --git a/examples/apidoc/RestClient/cancelAllBlockQuotes.js b/examples/apidoc/RestClient/cancelAllBlockQuotes.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAllBlockQuotes(params)

diff --git a/examples/apidoc/RestClient/cancelAllRFQs.js b/examples/apidoc/RestClient/cancelAllRFQs.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAllRFQs(params)

diff --git a/examples/apidoc/RestClient/cancelAllSpreadOrders.js b/examples/apidoc/RestClient/cancelAllSpreadOrders.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelAllSpreadOrders(params)

diff --git a/examples/apidoc/RestClient/cancelBlockQuote.js b/examples/apidoc/RestClient/cancelBlockQuote.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelBlockQuote(params)

diff --git a/examples/apidoc/RestClient/cancelBlockRFQ.js b/examples/apidoc/RestClient/cancelBlockRFQ.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelBlockRFQ(params)

diff --git a/examples/apidoc/RestClient/cancelGridContractCloseOrder.js b/examples/apidoc/RestClient/cancelGridContractCloseOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelGridContractCloseOrder(params)

diff --git a/examples/apidoc/RestClient/cancelMassOrder.js b/examples/apidoc/RestClient/cancelMassOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelMassOrder(params)

diff --git a/examples/apidoc/RestClient/cancelMultipleBlockQuotes.js b/examples/apidoc/RestClient/cancelMultipleBlockQuotes.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelMultipleBlockQuotes(params)

diff --git a/examples/apidoc/RestClient/cancelMultipleBlockRFQs.js b/examples/apidoc/RestClient/cancelMultipleBlockRFQs.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelMultipleBlockRFQs(params)

diff --git a/examples/apidoc/RestClient/cancelMultipleOrders.js b/examples/apidoc/RestClient/cancelMultipleOrders.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelMultipleOrders(params)

diff --git a/examples/apidoc/RestClient/cancelOrder.js b/examples/apidoc/RestClient/cancelOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelOrder(params)

diff --git a/examples/apidoc/RestClient/cancelSignalBots.js b/examples/apidoc/RestClient/cancelSignalBots.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelSignalBots(params)

diff --git a/examples/apidoc/RestClient/cancelSpreadAllAfter.js b/examples/apidoc/RestClient/cancelSpreadAllAfter.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelSpreadAllAfter(params)

diff --git a/examples/apidoc/RestClient/cancelSpreadOrder.js b/examples/apidoc/RestClient/cancelSpreadOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelSpreadOrder(params)

diff --git a/examples/apidoc/RestClient/cancelStakingRequest.js b/examples/apidoc/RestClient/cancelStakingRequest.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelStakingRequest(params)

diff --git a/examples/apidoc/RestClient/cancelSubOrder.js b/examples/apidoc/RestClient/cancelSubOrder.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelSubOrder(params)

diff --git a/examples/apidoc/RestClient/cancelWithdrawal.js b/examples/apidoc/RestClient/cancelWithdrawal.js
@@ -7,8 +7,9 @@ const { RestClient } = require('okx-api');
   // PUBLIC: NO
 
 const client = new RestClient({
-  apiKey: 'insert_api_key_here',
-  apiSecret: 'insert_api_secret_here',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 client.cancelWithdrawal(params)