Merge pull request #604 from JJ-Cro/update14112025

feat(v3.1.4): New algo orders, minor changes

Author: tiagosiebler

README.md

@@ -431,7 +431,7 @@ wsClient.subscribe('btcusd@miniTicker', 'coinm');
 
 // Or send many topics at once to a stream, e.g. the usdm futures stream:
 wsClient.subscribe(
-  ['btcusdt@aggTrade', 'btcusdt@markPrice', '!ticker@arr', '!miniTicker@arr'],
+  ['btcusdt@aggTrade', 'btcusdt@markPrice', '!miniTicker@arr'],
   'usdm',
 );
 

docs/endpointFunctionList.md

@@ -38,4 +38,5 @@ ws.on('message', (msg) => {
 });
 
 // Subscribe to a couple of topics
-ws.subscribe(['btcusdt@trade', '!ticker@arr'], 'main');
+// Note: '!ticker@arr' has been deprecated (2025-11-14). Using '!miniTicker@arr' instead.
+ws.subscribe(['btcusdt@trade', '!miniTicker@arr'], 'main');

examples/WebSockets/ws-custom-parser.ts

@@ -1,15 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import {
   DefaultLogger,
-  isWsAggTradeFormatted,
-  isWsFormatted24hrTicker,
-  isWsFormatted24hrTickerArray,
-  isWsFormattedForceOrder,
-  isWsFormattedKline,
-  isWsFormattedMarkPriceUpdateArray,
-  isWsFormattedMarkPriceUpdateEvent,
-  isWsFormattedRollingWindowTickerArray,
-  isWsFormattedTrade,
+  isWsDiffBookDepthEventFormatted,
   isWsPartialBookDepthEventFormatted,
   WebsocketClient,
 } from '../../src';
@@ -188,9 +180,10 @@ import {
         // Individual Symbol Ticker Streams
         // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#individual-symbol-ticker-streams
         'btcusdt@ticker',
-        // All Market Tickers Stream
+        // All Market Tickers Stream - DEPRECATED (2025-11-14)
         // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#all-market-tickers-stream
-        '!ticker@arr',
+        // '!ticker@arr', // DEPRECATED: Use '<symbol>@ticker' or '!miniTicker@arr' instead
+        // Recommended alternative: '!miniTicker@arr' for all market mini tickers (already subscribed above)
         // Individual Symbol Rolling Window Statistics Streams
         // https://developers.binance.com/docs/binance-spot-api-docs/web-socket-streams#individual-symbol-rolling-window-statistics-streams
         'btcusdt@ticker_1h',

examples/WebSockets/ws-public.ts

@@ -0,0 +1,20 @@
+const { USDMClient } = require('binance');
+
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
+  // ENDPOINT: fapi/v1/algoOrder
+  // METHOD: DELETE
+  // PUBLIC: NO
+
+const client = new USDMClient({
+  api_key: 'insert_api_key_here',
+  api_secret: 'insert_api_secret_here',
+});
+
+client.cancelAlgoOrder(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/USDMClient/cancelAlgoOrder.js

@@ -0,0 +1,20 @@
+const { USDMClient } = require('binance');
+
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
+  // ENDPOINT: fapi/v1/algoOpenOrders
+  // METHOD: DELETE
+  // PUBLIC: NO
+
+const client = new USDMClient({
+  api_key: 'insert_api_key_here',
+  api_secret: 'insert_api_secret_here',
+});
+
+client.cancelAllAlgoOpenOrders(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/USDMClient/cancelAllAlgoOpenOrders.js

@@ -0,0 +1,20 @@
+const { USDMClient } = require('binance');
+
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
+  // ENDPOINT: fapi/v1/algoOrder
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new USDMClient({
+  api_key: 'insert_api_key_here',
+  api_secret: 'insert_api_secret_here',
+});
+
+client.getAlgoOrder(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/USDMClient/getAlgoOrder.js

@@ -0,0 +1,20 @@
+const { USDMClient } = require('binance');
+
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
+  // ENDPOINT: fapi/v1/allAlgoOrders
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new USDMClient({
+  api_key: 'insert_api_key_here',
+  api_secret: 'insert_api_secret_here',
+});
+
+client.getAllAlgoOrders(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/USDMClient/getAllAlgoOrders.js

@@ -0,0 +1,20 @@
+const { USDMClient } = require('binance');
+
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
+  // ENDPOINT: fapi/v1/openAlgoOrders
+  // METHOD: GET
+  // PUBLIC: NO
+
+const client = new USDMClient({
+  api_key: 'insert_api_key_here',
+  api_secret: 'insert_api_secret_here',
+});
+
+client.getOpenAlgoOrders(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/USDMClient/getOpenAlgoOrders.js

@@ -0,0 +1,20 @@
+const { USDMClient } = require('binance');
+
+  // This example shows how to call this Binance API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "binance" for Binance exchange
+  // This Binance API SDK is available on npm via "npm install binance"
+  // ENDPOINT: fapi/v1/algoOrder
+  // METHOD: POST
+  // PUBLIC: NO
+
+const client = new USDMClient({
+  api_key: 'insert_api_key_here',
+  api_secret: 'insert_api_secret_here',
+});
+
+client.submitNewAlgoOrder(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });