Merge pull request #102 from JJ-Cro/updateExamples3101

tiagosiebler · web-flow · commit c1a7c8cca700 · 2026-01-30T11:22:18.000Z
feat: add new examples for futures and spot trading using REST and WebSocket clients
diff --git a/examples/Rest/futures/futures-balance-trade.ts b/examples/Rest/futures/futures-balance-trade.ts
@@ -8,7 +8,7 @@
  **/
 
 // Import the RestClient and WebsocketClient from the published version of this SDK, installed via NPM (npm install gateio-api)
-import { RestClient, WebsocketClient } from 'gateio-api';
+import { RestClient, WebsocketClient } from '../../../src/index.js';
 
 // Define the account object with API key and secret
 const account = {
@@ -68,7 +68,7 @@ async function subscribePrivateWs() {
 
     return true;
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
     throw e;
   }
 }
@@ -82,7 +82,7 @@ async function main() {
     const balances = await gateRestClient.getFuturesAccount({ settle: 'usdt' });
 
     // total usdt balance
-    const usdtBalance = Number(balances.total);
+    // const usdtBalance = Number(balances.total);
 
     // available usdt balance
     const availableBalance = Number(balances.available);
diff --git a/examples/Rest/futures/getBalances.ts b/examples/Rest/futures/getBalances.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -22,7 +22,7 @@ async function getFuturesBalances() {
 
     console.log('Response: ', result); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/futures/getOrders.ts b/examples/Rest/futures/getOrders.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -31,7 +31,7 @@ async function getFuturesOrders() {
     });
     console.log('finishedOrders: ', finishedOrders); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/futures/getTickers.ts b/examples/Rest/futures/getTickers.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -30,7 +30,7 @@ async function getFuturesTicker() {
     });
     console.log('ticker: ', ticker); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/futures/submitLimitOrder.ts b/examples/Rest/futures/submitLimitOrder.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -28,7 +28,7 @@ async function submitFuturesOrder() {
 
     console.log('Response: ', result); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/futures/submitMarketOrder.ts b/examples/Rest/futures/submitMarketOrder.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -28,7 +28,7 @@ async function submitFuturesOrder() {
 
     console.log('Response: ', result); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/futures/testnet.ts b/examples/Rest/futures/testnet.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -46,7 +46,7 @@ async function submitFuturesOrder() {
 
     console.log('Response: ', result); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/spot/getBalances.ts b/examples/Rest/spot/getBalances.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -21,7 +21,7 @@ async function getSpotBalances() {
     const balances = await gateRestClient.getSpotAccounts();
     console.log('Response: ', balances); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/spot/getCandles.ts b/examples/Rest/spot/getCandles.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -24,7 +24,7 @@ async function getSpotCandles() {
     });
     console.log('Response: ', balances); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/spot/getOrders.ts b/examples/Rest/spot/getOrders.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -31,7 +31,7 @@ async function getSpotOrders() {
     });
     console.log('finishedOrders: ', finishedOrders); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/spot/getTickers.ts b/examples/Rest/spot/getTickers.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -27,7 +27,7 @@ async function getSpotTicker() {
     const allTickers = await gateRestClient.getSpotTicker();
     console.log('Response: ', allTickers); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/spot/submitLimitOrder.ts b/examples/Rest/spot/submitLimitOrder.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -29,7 +29,7 @@ async function submitSpotOrder() {
 
     console.log('Response: ', result); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Rest/spot/submitMarketOrder.ts b/examples/Rest/spot/submitMarketOrder.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.
 // import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)
 
 // Define the account object with API key and secret
@@ -28,7 +28,7 @@ async function submitSpotOrder() {
 
     console.log('Response: ', result); // Log the response to the console
   } catch (e) {
-    console.error(`Error in execution: `, e); // Log any errors that occur
+    console.error('Error in execution: ', e); // Log any errors that occur
   }
 }
 
diff --git a/examples/Websocket/WS-API/ws-api-client.ts b/examples/Websocket/WS-API/ws-api-client.ts
@@ -1,4 +1,4 @@
-import { WebsocketAPIClient, WS_KEY_MAP } from '../src/index.js';
+import { WebsocketAPIClient, WS_KEY_MAP } from '../../../src/index.js';
 // import { LogParams, WebsocketClient } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 const account = {
diff --git a/examples/Websocket/WS-API/ws-private-perp-futures-wsapi.ts b/examples/Websocket/WS-API/ws-private-perp-futures-wsapi.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
-import { LogParams, WebsocketClient } from '../src/index.js';
+import { LogParams, WebsocketClient } from '../../../src/index.js';
 // import { LogParams, WebsocketClient } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 const account = {
@@ -226,7 +226,7 @@ async function start() {
 
     console.log(new Date(), 'Result: ', getStatus);
   } catch (e) {
-    console.error(`WS API Error: `, e);
+    console.error('WS API Error: ', e);
   }
 }
 
diff --git a/examples/Websocket/WS-API/ws-private-spot-wsapi.ts b/examples/Websocket/WS-API/ws-private-spot-wsapi.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
-import { LogParams, WebsocketClient } from '../src/index.js';
+import { LogParams, WebsocketClient } from '../../../src/index.js';
 // import { LogParams, WebsocketClient } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -215,7 +215,7 @@ async function start() {
     //     console.error(`exception ws api call, get spot order status: `, e);
     //   });
   } catch (e) {
-    console.error(`WS API Error: `, e);
+    console.error('WS API Error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-private-perp-futures.ts b/examples/Websocket/ws-private-perp-futures.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { LogParams, WebsocketClient, WsTopicRequest } from '../src/index.js';
+import { LogParams, WebsocketClient, WsTopicRequest } from '../../src/index.js';
 // import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 const account = {
@@ -107,7 +107,7 @@ async function start() {
       'perpFuturesUSDTV4',
     );
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-private-spot.ts b/examples/Websocket/ws-private-spot.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { LogParams, WebsocketClient, WsTopicRequest } from '../src/index.js';
+import { LogParams, WebsocketClient, WsTopicRequest } from '../../src/index.js';
 // import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -126,7 +126,7 @@ async function start() {
       'spotV4',
     );
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-public.ts b/examples/Websocket/ws-public.ts
@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { WebsocketClient, WsTopicRequest } from '../src/index.js';
+import { WebsocketClient, WsTopicRequest } from '../../src/index.js';
 // import { LogParams, WebsocketClient, WsTopicRequest } from 'gateio-api'; // normally you should install this module via npm: `npm install gateio-api`
 
 // const customLogger = {
@@ -97,7 +97,7 @@ async function start() {
     //   'spotV4',
     // );
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { RestClient } from '../../src'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.`
	`1`	`+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.`
`2`	`2`	`// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)`
`3`	`3`
`4`	`4`	`// Define the account object with API key and secret`
`@@ -22,7 +22,7 @@ async function getFuturesBalances() {`
`22`	`22`
`23`	`23`	`console.log('Response: ', result); // Log the response to the console`
`24`	`24`	`} catch (e) {`
`25`		- console.error(`Error in execution: `, e); // Log any errors that occur
	`25`	`+ console.error('Error in execution: ', e); // Log any errors that occur`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { RestClient } from '../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.`
	`1`	`+import { RestClient } from '../../../src/index.js'; // For an easy demonstration, import from the src dir. Normally though, see below to import from the npm installed version instead.`
`2`	`2`	`// import { RestClient } from 'gateio-api'; // Import the RestClient from the published version of this SDK, installed via NPM (npm install gateio-api)`
`3`	`3`
`4`	`4`	`// Define the account object with API key and secret`
`@@ -46,7 +46,7 @@ async function submitFuturesOrder() {`
`46`	`46`
`47`	`47`	`console.log('Response: ', result); // Log the response to the console`
`48`	`48`	`} catch (e) {`
`49`		- console.error(`Error in execution: `, e); // Log any errors that occur
	`49`	`+ console.error('Error in execution: ', e); // Log any errors that occur`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`