@danielgroen/dxtrade-api 1.0.24 → 1.0.25

package/README.md

@@ -26,7 +26,7 @@ npm install dxtrade-api
 - [x] Position metrics (per-position P&L)
 - [x] Account metrics, trade journal & trade history
 - [x] Symbol search & instrument info
-- [x] OHLC / price bar data
+- [x] OHLC / price bar data (one-shot & streaming)
 - [x] PnL assessments
 - [x] Multi-broker support (FTMO, Eightcap, Lark Funding)
 - [x] Persistent WebSocket with `connect()`
@@ -34,7 +34,7 @@ npm install dxtrade-api
 - [x] Full TypeScript support
 - [ ] Batch orders
 - [ ] Modify existing orders
-- [ ] Real-time price streaming
+- [x] Real-time OHLC streaming
 
 ## Quick Start
 
@@ -48,8 +48,8 @@ const client = new DxtradeClient({
   accountId: "optional_account_id",
 });
 
-// connect() = auth + persistent WebSocket (recommended)
-await client.connect();
+// await client.auth(); // Auth only
+await client.connect(); // Auth + persistent WebSocket (recommended)
 
 const suggestions = await client.symbols.search("EURUSD");
 const symbol = suggestions[0];
@@ -63,17 +63,17 @@ const order = await client.orders.submit({
 });
 
 console.log(`Order ${order.orderId}: ${order.status}`);
-client.disconnect();
+client.disconnect(); // disconnect stream -- only needed if client.connect()
 ```
 
 ## Connection Modes
 
 ```ts
-// Persistent WebSocket (recommended) — reuses one WS for all data, enables streaming
+// 1. Persistent WebSocket (recommended) — reuses one WS for all data, enables streaming
 await client.connect();
 client.disconnect(); // when done
 
-// Lightweight — auth only, each data call opens a temporary WebSocket
+// 2. Lightweight — auth only, each data call opens a temporary WebSocket
 await client.auth();
 ```
 
@@ -113,11 +113,10 @@ BROKER.FTMO         // "https://dxtrade.ftmo.com"
 
 ### Positions
 
-- `client.positions.get()` — Get all open positions
+- `client.positions.get()` — Get all open positions with P&L metrics merged (margin, plOpen, marketValue, etc.)
 - `client.positions.close(params)` — Close a position (supports partial closes via the quantity field)
 - `client.positions.closeAll()` — Close all open positions with market orders
-- `client.positions.metrics()` — Get position-level P&L metrics
-- `client.positions.stream(callback)` — Stream real-time position updates (requires `connect()`). Returns an unsubscribe function.
+- `client.positions.stream(callback)` — Stream real-time position updates with live P&L (requires `connect()`). Returns an unsubscribe function.
 
 ### Orders
 
@@ -145,6 +144,7 @@ BROKER.FTMO         // "https://dxtrade.ftmo.com"
 ### OHLC
 
 - `client.ohlc.get(params)` — Fetch OHLC price bars for a symbol (resolution, range, maxBars, priceField)
+- `client.ohlc.stream(params, callback)` — Stream real-time OHLC bar updates (requires `connect()`). Returns a promise that resolves with an unsubscribe function after the snapshot is received.
 
 ### Assessments
 
@@ -196,6 +196,8 @@ npm run example:symbols:info:btc
 npm run example:instruments:get
 npm run example:instruments:get:forex
 npm run example:ohlc:get
+npm run example:ohlc:stream
+npm run example:ohlc:stream:btc
 npm run example:assessments:get
 npm run example:assessments:get:btc
 ```

package/dist/index.d.mts

@@ -100,7 +100,8 @@ declare enum WS_MESSAGE {
 }
 declare namespace WS_MESSAGE {
     enum SUBTOPIC {
-        BIG_CHART_COMPONENT = "BigChartComponentPresenter-4"
+        BIG_CHART_COMPONENT = "BigChartComponentPresenter-4",
+        OHLC_STREAM = "OHLCStreamPresenter-0"
     }
 }
 
@@ -389,13 +390,28 @@ declare namespace Position {
         stopLoss: number | null;
     }
     interface Metrics {
-        positionCode: string;
-        openPl: number;
-        openPlPerLot: number;
-        currentPrice: number;
-        convertedOpenPl: number;
+        uid: string;
+        accountId: string;
+        margin: number;
+        plOpen: number;
+        plClosed: number;
+        totalCommissions: number;
+        totalFinancing: number;
+        plRate: number;
+        averagePrice: number;
+        marketValue: number;
         [key: string]: unknown;
     }
+    interface Full extends Get {
+        margin: number;
+        plOpen: number;
+        plClosed: number;
+        totalCommissions: number;
+        totalFinancing: number;
+        plRate: number;
+        averagePrice: number;
+        marketValue: number;
+    }
     interface Close {
         legs: {
             instrumentId: number;
@@ -441,16 +457,14 @@ declare namespace Symbol {
 declare class PositionsDomain {
     private _ctx;
     constructor(_ctx: ClientContext);
-    /** Get all open positions via WebSocket. */
-    get(): Promise<Position.Get[]>;
+    /** Get all open positions with P&L metrics merged. */
+    get(): Promise<Position.Full[]>;
     /** Close a position. Supports partial closes by specifying a quantity smaller than the full position size. */
     close(params: Position.Close): Promise<void>;
     /** Close all open positions with market orders. */
     closeAll(): Promise<void>;
-    /** Get position-level P&L metrics via WebSocket. */
-    metrics(): Promise<Position.Metrics[]>;
-    /** Stream real-time position updates. Requires connect(). Returns unsubscribe function. */
-    stream(callback: (positions: Position.Get[]) => void): () => void;
+    /** Stream real-time position updates with P&L metrics. Requires connect(). Returns unsubscribe function. */
+    stream(callback: (positions: Position.Full[]) => void): () => void;
 }
 declare class OrdersDomain {
     private _ctx;
@@ -519,6 +533,8 @@ declare class OhlcDomain {
      * @param params.priceField - "bid" or "ask" (default: "bid")
      */
     get(params: OHLC.Params): Promise<OHLC.Bar[]>;
+    /** Stream real-time OHLC bar updates. Requires connect(). Returns unsubscribe function. */
+    stream(params: OHLC.Params, callback: (bars: OHLC.Bar[]) => void): Promise<() => void>;
 }
 declare class AssessmentsDomain {
     private _ctx;
@@ -554,7 +570,7 @@ declare class DxtradeClient {
     readonly symbols: SymbolsDomain;
     /** Instrument operations: get (with optional filtering). */
     readonly instruments: InstrumentsDomain;
-    /** OHLC price bar operations: get. */
+    /** OHLC price bar operations: get, stream. */
     readonly ohlc: OhlcDomain;
     /** PnL assessment operations: get. */
     readonly assessments: AssessmentsDomain;

package/dist/index.d.ts

@@ -100,7 +100,8 @@ declare enum WS_MESSAGE {
 }
 declare namespace WS_MESSAGE {
     enum SUBTOPIC {
-        BIG_CHART_COMPONENT = "BigChartComponentPresenter-4"
+        BIG_CHART_COMPONENT = "BigChartComponentPresenter-4",
+        OHLC_STREAM = "OHLCStreamPresenter-0"
     }
 }
 
@@ -389,13 +390,28 @@ declare namespace Position {
         stopLoss: number | null;
     }
     interface Metrics {
-        positionCode: string;
-        openPl: number;
-        openPlPerLot: number;
-        currentPrice: number;
-        convertedOpenPl: number;
+        uid: string;
+        accountId: string;
+        margin: number;
+        plOpen: number;
+        plClosed: number;
+        totalCommissions: number;
+        totalFinancing: number;
+        plRate: number;
+        averagePrice: number;
+        marketValue: number;
         [key: string]: unknown;
     }
+    interface Full extends Get {
+        margin: number;
+        plOpen: number;
+        plClosed: number;
+        totalCommissions: number;
+        totalFinancing: number;
+        plRate: number;
+        averagePrice: number;
+        marketValue: number;
+    }
     interface Close {
         legs: {
             instrumentId: number;
@@ -441,16 +457,14 @@ declare namespace Symbol {
 declare class PositionsDomain {
     private _ctx;
     constructor(_ctx: ClientContext);
-    /** Get all open positions via WebSocket. */
-    get(): Promise<Position.Get[]>;
+    /** Get all open positions with P&L metrics merged. */
+    get(): Promise<Position.Full[]>;
     /** Close a position. Supports partial closes by specifying a quantity smaller than the full position size. */
     close(params: Position.Close): Promise<void>;
     /** Close all open positions with market orders. */
     closeAll(): Promise<void>;
-    /** Get position-level P&L metrics via WebSocket. */
-    metrics(): Promise<Position.Metrics[]>;
-    /** Stream real-time position updates. Requires connect(). Returns unsubscribe function. */
-    stream(callback: (positions: Position.Get[]) => void): () => void;
+    /** Stream real-time position updates with P&L metrics. Requires connect(). Returns unsubscribe function. */
+    stream(callback: (positions: Position.Full[]) => void): () => void;
 }
 declare class OrdersDomain {
     private _ctx;
@@ -519,6 +533,8 @@ declare class OhlcDomain {
      * @param params.priceField - "bid" or "ask" (default: "bid")
      */
     get(params: OHLC.Params): Promise<OHLC.Bar[]>;
+    /** Stream real-time OHLC bar updates. Requires connect(). Returns unsubscribe function. */
+    stream(params: OHLC.Params, callback: (bars: OHLC.Bar[]) => void): Promise<() => void>;
 }
 declare class AssessmentsDomain {
     private _ctx;
@@ -554,7 +570,7 @@ declare class DxtradeClient {
     readonly symbols: SymbolsDomain;
     /** Instrument operations: get (with optional filtering). */
     readonly instruments: InstrumentsDomain;
-    /** OHLC price bar operations: get. */
+    /** OHLC price bar operations: get, stream. */
     readonly ohlc: OhlcDomain;
     /** PnL assessment operations: get. */
     readonly assessments: AssessmentsDomain;

package/dist/index.js

@@ -152,6 +152,7 @@ var WS_MESSAGE = /* @__PURE__ */ ((WS_MESSAGE2) => {
   let SUBTOPIC;
   ((SUBTOPIC2) => {
     SUBTOPIC2["BIG_CHART_COMPONENT"] = "BigChartComponentPresenter-4";
+    SUBTOPIC2["OHLC_STREAM"] = "OHLCStreamPresenter-0";
   })(SUBTOPIC = WS_MESSAGE2.SUBTOPIC || (WS_MESSAGE2.SUBTOPIC = {}));
 })(WS_MESSAGE || (WS_MESSAGE = {}));
 
@@ -488,6 +489,95 @@ async function getInstruments(ctx, params = {}, timeout = 3e4) {
 
 // src/domains/ohlc/ohlc.ts
 var import_ws4 = __toESM(require("ws"));
+async function streamOHLC(ctx, params, callback) {
+  if (!ctx.wsManager) {
+    ctx.throwError(
+      "STREAM_REQUIRES_CONNECT" /* STREAM_REQUIRES_CONNECT */,
+      "Streaming requires a persistent WebSocket. Use connect() instead of auth()."
+    );
+  }
+  const { symbol, resolution = 60, range = 432e3, maxBars = 3500, priceField = "bid" } = params;
+  const subtopic = WS_MESSAGE.SUBTOPIC.OHLC_STREAM;
+  const headers = authHeaders(ctx.csrf, Cookies.serialize(ctx.cookies));
+  const snapshotBars = [];
+  let snapshotDone = false;
+  let resolveSnapshot = null;
+  const onChartFeed = (body) => {
+    if (body?.subtopic !== subtopic) return;
+    const data = body.data;
+    if (!Array.isArray(data)) return;
+    if (!snapshotDone) {
+      snapshotBars.push(...data);
+      if (body.snapshotEnd) {
+        snapshotDone = true;
+        callback([...snapshotBars]);
+        resolveSnapshot?.();
+      }
+    } else {
+      callback(data);
+    }
+  };
+  ctx.wsManager.on("chartFeedSubtopic" /* CHART_FEED_SUBTOPIC */, onChartFeed);
+  try {
+    await retryRequest(
+      {
+        method: "PUT",
+        url: endpoints.subscribeInstruments(ctx.broker),
+        data: { instruments: [symbol] },
+        headers
+      },
+      ctx.retries
+    );
+    await retryRequest(
+      {
+        method: "PUT",
+        url: endpoints.charts(ctx.broker),
+        data: {
+          chartIds: [],
+          requests: [
+            {
+              aggregationPeriodSeconds: resolution,
+              extendedSession: true,
+              forexPriceField: priceField,
+              id: 0,
+              maxBarsCount: maxBars,
+              range,
+              studySubscription: [],
+              subtopic,
+              symbol
+            }
+          ]
+        },
+        headers
+      },
+      ctx.retries
+    );
+  } catch (error) {
+    ctx.wsManager.removeListener("chartFeedSubtopic" /* CHART_FEED_SUBTOPIC */, onChartFeed);
+    const message = error instanceof Error ? error.message : "Unknown error";
+    ctx.throwError("OHLC_ERROR" /* OHLC_ERROR */, `OHLC stream subscription error: ${message}`);
+  }
+  await new Promise((resolve, reject) => {
+    if (snapshotDone) return resolve();
+    const timer = setTimeout(() => {
+      if (snapshotBars.length > 0) {
+        snapshotDone = true;
+        callback([...snapshotBars]);
+        resolve();
+      } else {
+        ctx.wsManager?.removeListener("chartFeedSubtopic" /* CHART_FEED_SUBTOPIC */, onChartFeed);
+        reject(new DxtradeError("OHLC_TIMEOUT" /* OHLC_TIMEOUT */, "OHLC stream snapshot timed out"));
+      }
+    }, 3e4);
+    resolveSnapshot = () => {
+      clearTimeout(timer);
+      resolve();
+    };
+  });
+  return () => {
+    ctx.wsManager?.removeListener("chartFeedSubtopic" /* CHART_FEED_SUBTOPIC */, onChartFeed);
+  };
+}
 async function getOHLC(ctx, params, timeout = 3e4) {
   ctx.ensureSession();
   const { symbol, resolution = 60, range = 432e3, maxBars = 3500, priceField = "bid" } = params;
@@ -892,6 +982,23 @@ async function submitOrder(ctx, params) {
 
 // src/domains/position/position.ts
 var import_ws7 = __toESM(require("ws"));
+function mergePositionsWithMetrics(positions, metrics) {
+  const metricsMap = new Map(metrics.map((m) => [m.uid, m]));
+  return positions.map((pos) => {
+    const m = metricsMap.get(pos.uid);
+    return {
+      ...pos,
+      margin: m?.margin ?? 0,
+      plOpen: m?.plOpen ?? 0,
+      plClosed: m?.plClosed ?? 0,
+      totalCommissions: m?.totalCommissions ?? 0,
+      totalFinancing: m?.totalFinancing ?? 0,
+      plRate: m?.plRate ?? 0,
+      averagePrice: m?.averagePrice ?? 0,
+      marketValue: m?.marketValue ?? 0
+    };
+  });
+}
 function streamPositions(ctx, callback) {
   if (!ctx.wsManager) {
     ctx.throwError(
@@ -899,25 +1006,38 @@ function streamPositions(ctx, callback) {
       "Streaming requires a persistent WebSocket. Use connect() instead of auth()."
     );
   }
-  const listener = (body) => callback(body);
-  ctx.wsManager.on("POSITIONS" /* POSITIONS */, listener);
-  const cached = ctx.wsManager.getCached("POSITIONS" /* POSITIONS */);
-  if (cached !== void 0) {
-    callback(cached);
-  }
+  const emit = () => {
+    const positions = ctx.wsManager.getCached("POSITIONS" /* POSITIONS */);
+    const metrics = ctx.wsManager.getCached("POSITION_METRICS" /* POSITION_METRICS */);
+    if (positions && metrics) {
+      callback(mergePositionsWithMetrics(positions, metrics));
+    }
+  };
+  const onPositions = () => emit();
+  const onMetrics = () => emit();
+  ctx.wsManager.on("POSITIONS" /* POSITIONS */, onPositions);
+  ctx.wsManager.on("POSITION_METRICS" /* POSITION_METRICS */, onMetrics);
+  emit();
   return () => {
-    ctx.wsManager?.removeListener("POSITIONS" /* POSITIONS */, listener);
+    ctx.wsManager?.removeListener("POSITIONS" /* POSITIONS */, onPositions);
+    ctx.wsManager?.removeListener("POSITION_METRICS" /* POSITION_METRICS */, onMetrics);
   };
 }
 async function getPositions(ctx) {
   ctx.ensureSession();
   if (ctx.wsManager) {
-    return ctx.wsManager.waitFor("POSITIONS" /* POSITIONS */);
+    const [positions, metrics] = await Promise.all([
+      ctx.wsManager.waitFor("POSITIONS" /* POSITIONS */),
+      ctx.wsManager.waitFor("POSITION_METRICS" /* POSITION_METRICS */)
+    ]);
+    return mergePositionsWithMetrics(positions, metrics);
   }
   const wsUrl = endpoints.websocket(ctx.broker, ctx.atmosphereId);
   const cookieStr = Cookies.serialize(ctx.cookies);
   return new Promise((resolve, reject) => {
     const ws = new import_ws7.default(wsUrl, { headers: { Cookie: cookieStr } });
+    let positions = null;
+    let metrics = null;
     const timer = setTimeout(() => {
       ws.close();
       reject(new DxtradeError("ACCOUNT_POSITIONS_TIMEOUT" /* ACCOUNT_POSITIONS_TIMEOUT */, "Account positions timed out"));
@@ -927,45 +1047,21 @@ async function getPositions(ctx) {
       if (shouldLog(msg, ctx.debug)) debugLog(msg);
       if (typeof msg === "string") return;
       if (msg.type === "POSITIONS" /* POSITIONS */) {
-        clearTimeout(timer);
-        ws.close();
-        resolve(msg.body);
+        positions = msg.body;
       }
-    });
-    ws.on("error", (error) => {
-      clearTimeout(timer);
-      ws.close();
-      reject(new DxtradeError("ACCOUNT_POSITIONS_ERROR" /* ACCOUNT_POSITIONS_ERROR */, `Account positions error: ${error.message}`));
-    });
-  });
-}
-async function getPositionMetrics(ctx, timeout = 3e4) {
-  ctx.ensureSession();
-  if (ctx.wsManager) {
-    return ctx.wsManager.waitFor("POSITION_METRICS" /* POSITION_METRICS */, timeout);
-  }
-  const wsUrl = endpoints.websocket(ctx.broker, ctx.atmosphereId);
-  const cookieStr = Cookies.serialize(ctx.cookies);
-  return new Promise((resolve, reject) => {
-    const ws = new import_ws7.default(wsUrl, { headers: { Cookie: cookieStr } });
-    const timer = setTimeout(() => {
-      ws.close();
-      reject(new DxtradeError("POSITION_METRICS_TIMEOUT" /* POSITION_METRICS_TIMEOUT */, "Position metrics timed out"));
-    }, timeout);
-    ws.on("message", (data) => {
-      const msg = parseWsData(data);
-      if (shouldLog(msg, ctx.debug)) debugLog(msg);
-      if (typeof msg === "string") return;
       if (msg.type === "POSITION_METRICS" /* POSITION_METRICS */) {
+        metrics = msg.body;
+      }
+      if (positions && metrics) {
         clearTimeout(timer);
         ws.close();
-        resolve(msg.body);
+        resolve(mergePositionsWithMetrics(positions, metrics));
       }
     });
     ws.on("error", (error) => {
       clearTimeout(timer);
       ws.close();
-      reject(new DxtradeError("POSITION_METRICS_ERROR" /* POSITION_METRICS_ERROR */, `Position metrics error: ${error.message}`));
+      reject(new DxtradeError("ACCOUNT_POSITIONS_ERROR" /* ACCOUNT_POSITIONS_ERROR */, `Account positions error: ${error.message}`));
     });
   });
 }
@@ -1152,7 +1248,7 @@ var PositionsDomain = class {
   constructor(_ctx) {
     this._ctx = _ctx;
   }
-  /** Get all open positions via WebSocket. */
+  /** Get all open positions with P&L metrics merged. */
   get() {
     return getPositions(this._ctx);
   }
@@ -1164,11 +1260,7 @@ var PositionsDomain = class {
   closeAll() {
     return closeAllPositions(this._ctx);
   }
-  /** Get position-level P&L metrics via WebSocket. */
-  metrics() {
-    return getPositionMetrics(this._ctx);
-  }
-  /** Stream real-time position updates. Requires connect(). Returns unsubscribe function. */
+  /** Stream real-time position updates with P&L metrics. Requires connect(). Returns unsubscribe function. */
   stream(callback) {
     return streamPositions(this._ctx, callback);
   }
@@ -1263,6 +1355,10 @@ var OhlcDomain = class {
   get(params) {
     return getOHLC(this._ctx, params);
   }
+  /** Stream real-time OHLC bar updates. Requires connect(). Returns unsubscribe function. */
+  stream(params, callback) {
+    return streamOHLC(this._ctx, params, callback);
+  }
 };
 var AssessmentsDomain = class {
   constructor(_ctx) {
@@ -1285,7 +1381,7 @@ var DxtradeClient = class {
   symbols;
   /** Instrument operations: get (with optional filtering). */
   instruments;
-  /** OHLC price bar operations: get. */
+  /** OHLC price bar operations: get, stream. */
   ohlc;
   /** PnL assessment operations: get. */
   assessments;