Merge pull request tiagosiebler#76 from JJ-Cro/updateExamples3101

tiagosiebler · web-flow · commit 0864d1c71304 · 2026-01-30T11:07:25.000Z
feat: add example scripts for Spot and Futures API interactions via REST and WebSocket clients
diff --git a/examples/Auth/fasterHmacSign.ts b/examples/Auth/fasterHmacSign.ts
@@ -1,6 +1,6 @@
 import { createHmac } from 'crypto';
 
-import { RestClient } from '../src';
+import { RestClient } from '../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { RestClient } from 'bitmart-api';
 
@@ -29,7 +29,7 @@ async function getSpotBalances() {
 
     console.log('Balances: ', JSON.stringify(balances, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Futures/futures-get-balances.ts b/examples/Rest/Futures/futures-get-balances.ts
@@ -1,4 +1,4 @@
-import { FuturesClientV2 } from '../src/index.js';
+import { FuturesClientV2 } from '../../../src/index.js';
 // // import from npm, after installing via npm `npm install bitmart-api`
 // import { FuturesClientV2 } from 'bitmart-api';
 
@@ -20,7 +20,7 @@ async function getFuturesAssets() {
 
     console.log('Balances: ', JSON.stringify(balances, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Futures/futures-get-klines.ts b/examples/Rest/Futures/futures-get-klines.ts
@@ -1,4 +1,4 @@
-import { FuturesClientV2 } from '../src/index.js';
+import { FuturesClientV2 } from '../../../src/index.js';
 // // import from npm, after installing via npm `npm install bitmart-api`
 // import { FuturesClientV2 } from 'bitmart-api';
 
@@ -14,7 +14,7 @@ async function getFuturesKlines() {
 
     console.log('Tickers: ', JSON.stringify(klines, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Futures/futures-get-tickers.ts b/examples/Rest/Futures/futures-get-tickers.ts
@@ -1,4 +1,4 @@
-import { FuturesClientV2 } from '../src/index.js';
+import { FuturesClientV2 } from '../../../src/index.js';
 // // import from npm, after installing via npm `npm install bitmart-api`
 // import { FuturesClientV2 } from 'bitmart-api';
 
@@ -10,7 +10,7 @@ async function getFuturesTickers() {
 
     console.log('Tickers: ', JSON.stringify(tickers, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Futures/futures-submit-order.ts b/examples/Rest/Futures/futures-submit-order.ts
@@ -1,4 +1,4 @@
-import { FuturesClientV2 } from '../src/index.js';
+import { FuturesClientV2 } from '../../../src/index.js';
 // // import from npm, after installing via npm `npm install bitmart-api`
 // import { FuturesClientV2 } from 'bitmart-api';
 
@@ -21,12 +21,13 @@ async function SumbitFuturesOrder() {
       type: 'market',
       side: 1, // Order side - 1=buy_open_long  -2=buy_close_short  -3=sell_close_long  -4=sell_open_short
       size: 1,
+      leverage: '1',
       open_type: 'cross',
     });
 
     console.log('Order: ', JSON.stringify(order, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Spot/spot-get-balances.ts b/examples/Rest/Spot/spot-get-balances.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../src';
+import { RestClient } from '../../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { RestClient } from 'bitmart-api';
 
@@ -20,7 +20,7 @@ async function getSpotBalances() {
 
     console.log('Balances: ', JSON.stringify(balances, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Spot/spot-get-klines.ts b/examples/Rest/Spot/spot-get-klines.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../src';
+import { RestClient } from '../../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { RestClient } from 'bitmart-api';
 
@@ -10,7 +10,7 @@ async function getKlines() {
 
     console.log('Tickers: ', JSON.stringify(klines, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Spot/spot-get-symbols.ts b/examples/Rest/Spot/spot-get-symbols.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../src';
+import { RestClient } from '../../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { RestClient } from 'bitmart-api';
 
@@ -10,7 +10,7 @@ async function getTickers() {
 
     console.log('Tickers: ', JSON.stringify(tickers, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Rest/Spot/spot-submit-order.ts b/examples/Rest/Spot/spot-submit-order.ts
@@ -1,4 +1,4 @@
-import { RestClient } from '../src';
+import { RestClient } from '../../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { RestClient } from 'bitmart-api';
 
@@ -43,7 +43,7 @@ async function start() {
     });
     console.log('res ', JSON.stringify(res, null, 2));
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-custom-logger.ts b/examples/Websocket/ws-custom-logger.ts
@@ -1,4 +1,4 @@
-import { DefaultLogger, LogParams, WebsocketClient } from '../src';
+import { DefaultLogger, LogParams, WebsocketClient } from '../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { DefaultLogger, LogParams, WebsocketClient } from 'bitmart-api';
 
@@ -59,7 +59,7 @@ async function start() {
     client.subscribe('spot/ticker:BTC_USDT', 'spot');
     //
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-futures-private.ts b/examples/Websocket/ws-futures-private.ts
@@ -1,4 +1,4 @@
-import { DefaultLogger, LogParams, WebsocketClient } from '../src/index.js';
+import { DefaultLogger, LogParams, WebsocketClient } from '../../src/index.js';
 
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { DefaultLogger, LogParams, WebsocketClient } from 'bitmart-api';
@@ -70,7 +70,7 @@ async function start() {
     // Order Channel
     // client.subscribe('futures/order', 'futures');
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-futures-public.ts b/examples/Websocket/ws-futures-public.ts
@@ -1,4 +1,4 @@
-import { WebsocketClient } from '../src';
+import { WebsocketClient } from '../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { WebsocketClient } from 'bitmart-api';
 
@@ -63,7 +63,7 @@ async function start() {
       'futures',
     );
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-spot-private.ts b/examples/Websocket/ws-spot-private.ts
@@ -1,4 +1,4 @@
-import { LogParams, WebsocketClient } from '../src';
+import { LogParams, WebsocketClient } from '../../src/index.js';
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { LogParams, WebsocketClient } from 'bitmart-api';
 
@@ -75,7 +75,7 @@ async function start() {
     // balance updates
     // client.subscribe('spot/user/balance:BALANCE_UPDATE', 'spot');
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 
diff --git a/examples/Websocket/ws-spot-public.ts b/examples/Websocket/ws-spot-public.ts
@@ -1,7 +1,4 @@
-import {
-  WebsocketClient,
-  // WsSpotOperation,
-} from '../src';
+import { WebsocketClient } from '../../src/index.js';
 
 // import from npm, after installing via npm `npm install bitmart-api`
 // import { WebsocketClient } from 'bitmart-api';
@@ -92,7 +89,7 @@ async function start() {
       'spot',
     );
   } catch (e) {
-    console.error(`Req error: `, e);
+    console.error('Req error: ', e);
   }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { createHmac } from 'crypto';`
`2`	`2`
`3`		`-import { RestClient } from '../src';`
	`3`	`+import { RestClient } from '../../src/index.js';`
`4`	`4`	// import from npm, after installing via npm `npm install bitmart-api`
`5`	`5`	`// import { RestClient } from 'bitmart-api';`
`6`	`6`
`@@ -29,7 +29,7 @@ async function getSpotBalances() {`
`29`	`29`
`30`	`30`	`console.log('Balances: ', JSON.stringify(balances, null, 2));`
`31`	`31`	`} catch (e) {`
`32`		- console.error(`Req error: `, e);
	`32`	`+ console.error('Req error: ', e);`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { FuturesClientV2 } from '../src/index.js';`
	`1`	`+import { FuturesClientV2 } from '../../../src/index.js';`
`2`	`2`	// // import from npm, after installing via npm `npm install bitmart-api`
`3`	`3`	`// import { FuturesClientV2 } from 'bitmart-api';`
`4`	`4`
`@@ -20,7 +20,7 @@ async function getFuturesAssets() {`
`20`	`20`
`21`	`21`	`console.log('Balances: ', JSON.stringify(balances, null, 2));`
`22`	`22`	`} catch (e) {`
`23`		- console.error(`Req error: `, e);
	`23`	`+ console.error('Req error: ', e);`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { RestClient } from '../src';`
	`1`	`+import { RestClient } from '../../../src/index.js';`
`2`	`2`	// import from npm, after installing via npm `npm install bitmart-api`
`3`	`3`	`// import { RestClient } from 'bitmart-api';`
`4`	`4`
`@@ -20,7 +20,7 @@ async function getSpotBalances() {`
`20`	`20`
`21`	`21`	`console.log('Balances: ', JSON.stringify(balances, null, 2));`
`22`	`22`	`} catch (e) {`
`23`		- console.error(`Req error: `, e);
	`23`	`+ console.error('Req error: ', e);`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { DefaultLogger, LogParams, WebsocketClient } from '../src';`
	`1`	`+import { DefaultLogger, LogParams, WebsocketClient } from '../../src/index.js';`
`2`	`2`	// import from npm, after installing via npm `npm install bitmart-api`
`3`	`3`	`// import { DefaultLogger, LogParams, WebsocketClient } from 'bitmart-api';`
`4`	`4`
`@@ -59,7 +59,7 @@ async function start() {`
`59`	`59`	`client.subscribe('spot/ticker:BTC_USDT', 'spot');`
`60`	`60`	`//`
`61`	`61`	`} catch (e) {`
`62`		- console.error(`Req error: `, e);
	`62`	`+ console.error('Req error: ', e);`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`