Merge pull request #155 from JJ-Cro/update17112025

feat(v3.0.11): add new API endpoints for trading configuration and delta neutral strategy

Author: tiagosiebler

docs/endpointFunctionList.md

@@ -0,0 +1,21 @@
+const { RestClient } = require('okx-api');
+
+  // This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
+  // This OKX API SDK is available on npm via "npm install okx-api"
+  // ENDPOINT: /api/v5/account/precheck-set-delta-neutral
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.precheckSetDeltaNeutral(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/precheckSetDeltaNeutral.js

@@ -0,0 +1,21 @@
+const { RestClient } = require('okx-api');
+
+  // This example shows how to call this OKX API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "okx-api" for OKX exchange
+  // This OKX API SDK is available on npm via "npm install okx-api"
+  // ENDPOINT: /api/v5/account/set-trading-config
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new RestClient({
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
+});
+
+client.setTradingConfig(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/RestClient/setTradingConfig.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: batch-amend-orders
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed

examples/apidoc/WebsocketAPIClient/amendMultipleOrders.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: amend-order
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed

examples/apidoc/WebsocketAPIClient/amendOrder.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: sprd-amend-order
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed

examples/apidoc/WebsocketAPIClient/amendSpreadOrder.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: batch-cancel-orders
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed

examples/apidoc/WebsocketAPIClient/cancelMultipleOrders.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: cancel-order
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed

examples/apidoc/WebsocketAPIClient/cancelOrder.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: sprd-cancel-order
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed

examples/apidoc/WebsocketAPIClient/cancelSpreadOrder.js

@@ -4,13 +4,13 @@ const { WebsocketAPIClient } = require('okx-api');
 // This OKX API SDK is available on npm via "npm install okx-api"
 // WS API ENDPOINT: mass-cancel
 // METHOD: WebSocket API
-// PUBLIC: 'NO'
+// PUBLIC: NO
 
 // Create a WebSocket API client instance
 const client = new WebsocketAPIClient({
-  apiKey: 'apiKeyHere',
-  apiSecret: 'apiSecretHere',
-  apiPass: 'apiPassHere',
+    apiKey: 'apiKeyHere',
+    apiSecret: 'apiSecretHere',
+    apiPass: 'apiPassHere',
 });
 
 // The WebSocket connection is established automatically when needed