Merge pull request #631 from JJ-Cro/updateExamples3001

tiagosiebler · web-flow · commit 5c270ff13dc4 · 2026-01-30T11:01:24.000Z
feat: add multiple examples for futures and spot trading, including demo trading and websocket integration
diff --git a/examples/Rest/Futures/rest-future-bracket-order.ts b/examples/Rest/Futures/rest-future-bracket-order.ts
@@ -1,4 +1,4 @@
-import { NewFuturesOrderParams, USDMClient } from '../../src/index';
+import { NewFuturesOrderParams, USDMClient } from '../../../src/index';
 
 const key = process.env.API_KEY_COM || 'APIKEY';
 const secret = process.env.API_SECRET_COM || 'APISECRET';
@@ -9,9 +9,6 @@ const client = new USDMClient({
   beautifyResponses: true,
 });
 
-const symbol = 'ETHUSDT';
-
-// submit a 1:1 bracket market buy order with market entry order
 (async () => {
   try {
     // TODO: check balance and do other validations
diff --git a/examples/Rest/Futures/rest-usdm-demo.ts b/examples/Rest/Futures/rest-usdm-demo.ts
@@ -1,4 +1,4 @@
-import { USDMClient } from '../../src/index';
+import { USDMClient } from '../../../src/index';
 
 // or
 // import { USDMClient } from 'binance';
diff --git a/examples/Rest/Futures/rest-usdm-order-sl.ts b/examples/Rest/Futures/rest-usdm-order-sl.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { USDMClient } from '../../src/index';
+import { USDMClient } from '../../../src/index';
 
 // or
 // import { USDMClient } from 'binance';
diff --git a/examples/Rest/Futures/rest-usdm-order.ts b/examples/Rest/Futures/rest-usdm-order.ts
@@ -1,4 +1,4 @@
-import { USDMClient } from '../../src/index';
+import { USDMClient } from '../../../src/index';
 
 // or
 // import { USDMClient } from 'binance';
diff --git a/examples/Rest/Futures/rest-usdm-private-get.ts b/examples/Rest/Futures/rest-usdm-private-get.ts
@@ -1,4 +1,4 @@
-import { USDMClient } from '../../src/index';
+import { USDMClient } from '../../../src/index';
 // import axios from 'axios';
 
 // or
diff --git a/examples/Rest/Futures/rest-usdm-public.ts b/examples/Rest/Futures/rest-usdm-public.ts
@@ -1,4 +1,4 @@
-import { USDMClient } from '../../src';
+import { USDMClient } from '../../../src';
 
 const client = new USDMClient({
   testnet: true,
diff --git a/examples/Rest/Futures/rest-usdm-testnet.ts b/examples/Rest/Futures/rest-usdm-testnet.ts
@@ -1,4 +1,4 @@
-import { USDMClient } from '../../src/index';
+import { USDMClient } from '../../../src/index';
 
 // or
 // import { USDMClient } from 'binance';
diff --git a/examples/Rest/Portfolio Margin/rest-portfoliomargin-private.ts b/examples/Rest/Portfolio Margin/rest-portfoliomargin-private.ts
@@ -1,4 +1,4 @@
-import { PortfolioClient } from '../../src/index';
+import { PortfolioClient } from '../../../src/index';
 
 // or
 // import { PortfolioClient } from 'binance';
diff --git a/examples/Rest/Portfolio Margin/rest-portfoliomargin-public.ts b/examples/Rest/Portfolio Margin/rest-portfoliomargin-public.ts
@@ -1,4 +1,4 @@
-import { PortfolioClient } from '../../src/index';
+import { PortfolioClient } from '../../../src/index';
 
 // or
 // import { PortfolioClient } from 'binance';
diff --git a/examples/Rest/Spot/rest-spot-demo.ts b/examples/Rest/Spot/rest-spot-demo.ts
@@ -1,4 +1,4 @@
-import { MainClient } from '../../src/index';
+import { MainClient } from '../../../src/index';
 
 // or
 // import { MainClient } from 'binance';
diff --git a/examples/Rest/Spot/rest-spot-exchange-info.ts b/examples/Rest/Spot/rest-spot-exchange-info.ts
@@ -1,10 +1,10 @@
 import {
-    ExchangeInfo,
-    MainClient,
-    numberInString,
-    roundToStepSize,
-    roundToTickSize,
-} from '../../src'; // from 'binance';
+  ExchangeInfo,
+  MainClient,
+  numberInString,
+  roundToStepSize,
+  roundToTickSize,
+} from '../../../src'; // from 'binance';
 
 // or
 // import { MainClient } from 'binance';
diff --git a/examples/Rest/Spot/rest-spot-private-autoinvest.ts b/examples/Rest/Spot/rest-spot-private-autoinvest.ts
@@ -1,4 +1,4 @@
-import { MainClient } from '../../src/index';
+import { MainClient } from '../../../src/index';
 
 // or
 // import { MainClient } from 'binance';
diff --git a/examples/Rest/Spot/rest-spot-private-misc.ts b/examples/Rest/Spot/rest-spot-private-misc.ts
@@ -1,4 +1,4 @@
-import { MainClient } from '../../src/index';
+import { MainClient } from '../../../src/index';
 
 // or
 // import { MainClient } from 'binance';
diff --git a/examples/Rest/Spot/rest-spot-private-trade.ts b/examples/Rest/Spot/rest-spot-private-trade.ts
@@ -3,7 +3,7 @@ import {
   NewSpotOrderParams,
   OrderResponseFull,
   SymbolPrice,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or
 // import { MainClient } from 'binance';
diff --git a/examples/Rest/Spot/rest-spot-public.ts b/examples/Rest/Spot/rest-spot-public.ts
@@ -1,4 +1,4 @@
-import { MainClient } from '../../src/index';
+import { MainClient } from '../../../src/index';
 
 // or
 // import { MainClient } from 'binance';
diff --git a/examples/Rest/misc/README.md b/examples/Rest/misc/README.md
diff --git a/examples/Rest/misc/tracking-candles.ts b/examples/Rest/misc/tracking-candles.ts
@@ -6,7 +6,7 @@ import {
   KlineInterval,
   USDMClient,
   WebsocketClient,
-} from '../../src';
+} from '../../../src';
 
 // or, with the npm package
 /*
diff --git a/examples/WebSockets/Demo/ws-demo-spot.ts b/examples/WebSockets/Demo/ws-demo-spot.ts
@@ -1,4 +1,4 @@
-import { WebsocketClient } from '../../src';
+import { WebsocketClient } from '../../../src';
 
 // or
 // import { WebsocketClient } from 'binance';
diff --git a/examples/WebSockets/Demo/ws-demo-usdm.ts b/examples/WebSockets/Demo/ws-demo-usdm.ts
@@ -1,4 +1,4 @@
-import { WebsocketClient } from '../../src';
+import { WebsocketClient } from '../../../src';
 
 // or
 // import { WebsocketClient } from 'binance';
diff --git a/examples/WebSockets/Misc/ws-close.ts b/examples/WebSockets/Misc/ws-close.ts
@@ -1,4 +1,4 @@
-import { DefaultLogger, WebsocketClient } from '../../src/index';
+import { DefaultLogger, WebsocketClient } from '../../../src/index';
 
 // or
 // import { DefaultLogger, WebsocketClient } from 'binance';
diff --git a/examples/WebSockets/Misc/ws-custom-parser.ts b/examples/WebSockets/Misc/ws-custom-parser.ts
@@ -2,7 +2,7 @@
 // Import 3rd party library for parsing big number types in JSON
 // import JSONbig from 'json-bigint';
 
-import { WebsocketClient } from '../../src';
+import { WebsocketClient } from '../../../src';
 
 // Demonstrates using a custom JSON parser for incoming WS messages to preserve big integers
 
diff --git a/examples/WebSockets/Misc/ws-proxy-socks.ts b/examples/WebSockets/Misc/ws-proxy-socks.ts
@@ -1,7 +1,7 @@
 /**
  * Minimal example for using a socks proxy with the ws client, extracted from https://github.com/tiagosiebler/binance/pull/319
  */
-import { WebsocketClient } from '../../src/index';
+import { WebsocketClient } from '../../../src/index';
 
 // or
 // import { WebsocketClient } from 'binance';
diff --git a/examples/WebSockets/Misc/ws-unsubscribe.ts b/examples/WebSockets/Misc/ws-unsubscribe.ts
@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
-import { WebsocketClient } from '../../src/index';
+import { WebsocketClient } from '../../../src/index';
 
 // or, with the npm package
 /*
diff --git a/examples/WebSockets/Private(userdata)/ws-userdata-README.MD b/examples/WebSockets/Private(userdata)/ws-userdata-README.MD
diff --git a/examples/WebSockets/Private(userdata)/ws-userdata-connection-safety.ts b/examples/WebSockets/Private(userdata)/ws-userdata-connection-safety.ts
@@ -6,7 +6,7 @@ import {
   isWsFormattedUserDataEvent,
   WebsocketClient,
   WsUserDataEvents,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or
 // import { DefaultLogger, WebsocketClient } from 'binance';
diff --git a/examples/WebSockets/Private(userdata)/ws-userdata-listenKey-testnet.ts b/examples/WebSockets/Private(userdata)/ws-userdata-listenKey-testnet.ts
@@ -6,7 +6,7 @@ import {
   isWsFormattedUserDataEvent,
   WebsocketClient,
   WsUserDataEvents,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or
 // import { DefaultLogger, WebsocketClient } from 'binance';
diff --git a/examples/WebSockets/Private(userdata)/ws-userdata-listenkey.ts b/examples/WebSockets/Private(userdata)/ws-userdata-listenkey.ts
@@ -17,8 +17,8 @@ import {
   isWsFormattedUserDataEvent,
   WebsocketClient,
   WsUserDataEvents,
-} from '../../src/index';
-import { WsConnectionStateEnum } from '../../src/util/websockets/WsStore.types';
+} from '../../../src/index';
+import { WsConnectionStateEnum } from '../../../src/util/websockets/WsStore.types';
 
 (async () => {
   const key = process.env.API_KEY_COM || 'APIKEY';
diff --git a/examples/WebSockets/Private(userdata)/ws-userdata-wsapi.ts b/examples/WebSockets/Private(userdata)/ws-userdata-wsapi.ts
@@ -13,7 +13,7 @@ import {
   WebsocketAPIClient,
   WebsocketClient,
   WS_KEY_MAP,
-} from '../../src';
+} from '../../../src';
 
 /**
  * The WS API only works with an Ed25519 API key.
diff --git a/examples/WebSockets/Public/ws-public-spot-orderbook.ts b/examples/WebSockets/Public/ws-public-spot-orderbook.ts
@@ -5,7 +5,7 @@ import {
   isWsPartialBookDepthEventFormatted,
   WebsocketClient,
   WsMessagePartialBookDepthEventFormatted,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or, with the npm package
 /*
diff --git a/examples/WebSockets/Public/ws-public-spot-trades.ts b/examples/WebSockets/Public/ws-public-spot-trades.ts
@@ -2,7 +2,7 @@ import {
   DefaultLogger,
   isWsFormattedTrade,
   WebsocketClient,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or, with the npm package
 /*
diff --git a/examples/WebSockets/Public/ws-public-usdm-funding.ts b/examples/WebSockets/Public/ws-public-usdm-funding.ts
@@ -2,7 +2,7 @@ import {
   DefaultLogger,
   isWsFormattedMarkPriceUpdateArray,
   WebsocketClient,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or, with the npm package
 /*
diff --git a/examples/WebSockets/Public/ws-public.ts b/examples/WebSockets/Public/ws-public.ts
@@ -4,7 +4,7 @@ import {
   isWsDiffBookDepthEventFormatted,
   isWsPartialBookDepthEventFormatted,
   WebsocketClient,
-} from '../../src';
+} from '../../../src';
 
 // or, with the npm package
 /*
diff --git a/examples/WebSockets/WS-API/ws-api-client.ts b/examples/WebSockets/WS-API/ws-api-client.ts
@@ -4,7 +4,7 @@
 // or
 // const { DefaultLogger, WebsocketAPIClient, WS_KEY_MAP } = require('binance');
 
-import { DefaultLogger, WebsocketAPIClient } from '../../src';
+import { DefaultLogger, WebsocketAPIClient } from '../../../src';
 
 /**
  * The WS API only works with an Ed25519 API key.
diff --git a/examples/WebSockets/WS-API/ws-api-raw-promises.ts b/examples/WebSockets/WS-API/ws-api-raw-promises.ts
@@ -4,7 +4,7 @@ import {
   WebsocketClient,
   WS_KEY_MAP,
   WSAPIWsKey,
-} from '../../src/index';
+} from '../../../src/index';
 
 // or
 // import { DefaultLogger, WS_KEY_MAP, WebsocketClient, WSAPIWsKey } from 'binance';
diff --git a/examples/WebSockets/deprecated-ws-public.ts b/examples/WebSockets/deprecated-ws-public.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { USDMClient } from '../../src/index';`
	`1`	`+import { USDMClient } from '../../../src/index';`
`2`	`2`
`3`	`3`	`// or`
`4`	`4`	`// import { USDMClient } from 'binance';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { USDMClient } from '../../src';`
	`1`	`+import { USDMClient } from '../../../src';`
`2`	`2`
`3`	`3`	`const client = new USDMClient({`
`4`	`4`	`testnet: true,`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { PortfolioClient } from '../../src/index';`
	`1`	`+import { PortfolioClient } from '../../../src/index';`
`2`	`2`
`3`	`3`	`// or`
`4`	`4`	`// import { PortfolioClient } from 'binance';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { MainClient } from '../../src/index';`
	`1`	`+import { MainClient } from '../../../src/index';`
`2`	`2`
`3`	`3`	`// or`
`4`	`4`	`// import { MainClient } from 'binance';`