Merge pull request sieblyio#177 from JJ-Cro/updateexamples04022025

feat: add new examples for REST and WebSocket API usage, including private trading and public API calls, and restructure example directories

Author: tiagosiebler

examples/app.okx.com.ts examples/Rest/app.okx.com.tsexamples/app.okx.com.ts renamed to examples/Rest/app.okx.com.ts

@@ -1,4 +1,4 @@
-import { RestClient, WebsocketClient } from '../src/index.js';
+import { RestClient, WebsocketClient } from '../../src/index.js';
 
 // or
 // import { RestClient } from 'okx-api';

examples/rest-private-trade-market.ts …amples/Rest/rest-private-trade-market.tsexamples/rest-private-trade-market.ts renamed to examples/Rest/rest-private-trade-market.ts examples/rest-private-trade-market.ts renamed to examples/Rest/rest-private-trade-market.ts

@@ -1,4 +1,4 @@
-import { OrderRequest, RestClient } from '../src/index.js';
+import { OrderRequest, RestClient } from '../../src/index.js';
 
 // or
 // import { RestClient, OrderRequest } from 'okx-api';

examples/Rest/rest-private-trade.ts

@@ -42,17 +42,17 @@ const client = new RestClient({
 //   apiPass: API_PASS,
 // });
 
-function logWSEvent(type, data) {
+function logWSEvent(type: string, data: any) {
   console.log(new Date(), `WS ${type} event: `, data);
 }
 
 // simple sleep function
-function promiseSleep(milliseconds) {
+function promiseSleep(milliseconds: number) {
   return new Promise((resolve) => setTimeout(resolve, milliseconds));
 }
 
 // WARNING: for sensitive math you should be using a library such as decimal.js!
-function roundDown(value, decimals) {
+function roundDown(value: any, decimals: number) {
   return Number(
     Math.floor(parseFloat(value + 'e' + decimals)) + 'e-' + decimals,
   );

examples/Websocket/WS-API/ws-api-client.ts

@@ -29,7 +29,7 @@ import { DefaultLogger, WebsocketAPIClient } from '../../../src/index.js';
 (async () => {
   const logger = {
     ...DefaultLogger,
-    trace: (...params) => console.log('trace', ...params),
+    trace: (...params: any[]) => console.log('trace', ...params),
   };
 
   // For private events, all 3 of the following are required (per account):

examples/Websocket/WS-API/ws-api-trade-raw.ts

@@ -14,7 +14,7 @@ import {
 (async () => {
   const logger = {
     ...DefaultLogger,
-    trace: (...params) => console.log('trace', ...params),
+    trace: (...params: any[]) => console.log('trace', ...params),
   };
 
   // For private events, all 3 of the following are required (per account):

examples/Websocket/app.okx.com.ts

@@ -0,0 +1,68 @@
+import { RestClient, WebsocketClient } from '../../src/index.js';
+
+// or
+// import { RestClient } from 'okx-api';
+
+const client = new RestClient({
+  /**
+   * To use "app.okx.com", set market to "US"
+   *
+   * Note: your available functionality may differ, refer to the corresponding API docs for more details:
+   * https://app.okx.com/docs-v5/en/#overview-production-trading-services
+   */
+  market: 'US',
+});
+
+const wsClient = new WebsocketClient({
+  market: 'US',
+});
+
+/**
+ * This is a simple script wrapped in a immediately invoked function expression, designed to make public API calls without credentials
+ */
+(async () => {
+  try {
+    const results = await client.getInstruments({ instType: 'SPOT' });
+
+    console.log(
+      'result: ',
+      results.filter((row) => row.baseCcy === 'SUI'),
+    );
+  } catch (e) {
+    console.error('request failed: ', e);
+  }
+
+  // Raw data will arrive on the 'update' event
+  wsClient.on('update', (data) => {
+    // console.log(
+    //   new Date(),
+    //   'ws update (raw data received)',
+    //   JSON.stringify(data, null, 2),
+    // );
+    // console.log('ws update (raw data received)', JSON.stringify(data, null, 2));
+    console.log(
+      new Date(),
+      'ws update (raw data received)',
+      JSON.stringify(data),
+    );
+  });
+  wsClient.on('open', (data) => {
+    console.log('ws connection opened open:', data.wsKey);
+  });
+  wsClient.on('reconnected', (data) => {
+    console.log('ws has reconnected ', data?.wsKey);
+  });
+  wsClient.on('exception', (data) => {
+    console.error('ws exception: ', data);
+  });
+  wsClient.subscribe([
+    {
+      channel: 'instruments',
+      instType: 'SPOT',
+    },
+    {
+      channel: 'tickers',
+      instId: 'ETH-BTC',
+    },
+  ]);
+})();