@danielgroen/dxtrade-api 1.0.19 → 1.0.21

package/README.md

@@ -1,6 +1,7 @@
 # DXtrade API
 
-[![npm version](https://img.shields.io/npm/v/@danielgroen/dxtrade-api)](https://www.npmjs.com/package/@danielgroen/dxtrade-api)
+[![Node.js](https://img.shields.io/badge/Node.js-339933?logo=nodedotjs&logoColor=white)](https://nodejs.org)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
 [![npm downloads](https://img.shields.io/npm/dm/@danielgroen/dxtrade-api)](https://www.npmjs.com/package/@danielgroen/dxtrade-api)
 [![license](https://img.shields.io/npm/l/@danielgroen/dxtrade-api)](LICENSE)
 [![Tests](https://github.com/danielgroen/dxtrade-api/actions/workflows/tests.yml/badge.svg)](https://github.com/danielgroen/dxtrade-api/actions/workflows/tests.yml)
@@ -8,7 +9,7 @@
 
 [![DXtrade API](https://raw.githubusercontent.com/danielgroen/dxtrade-api/master/public/logo-dxtrade.svg)](https://demo.dx.trade/developers/#/)
 
-Unofficial TypeScript client for the DXtrade trading API. Connect, trade, and manage positions on any broker that supports DXtrade.
+Unofficial Node.js client for the DXtrade trading API with full TypeScript support. Connect, trade, and manage positions on any broker that supports DXtrade.
 
 ## Install
 
@@ -23,8 +24,10 @@ npm install dxtrade-api
 - [x] Positions (get & close)
 - [x] Account metrics & trade journal
 - [x] Symbol search & instrument info
+- [x] OHLC / price bar data
 - [x] PnL assessments
 - [x] Multi-broker support (FTMO, Eightcap, Lark Funding)
+- [x] Full TypeScript support
 - [ ] Batch orders
 - [ ] Close whole position helper
 - [ ] Modify existing orders
@@ -97,6 +100,7 @@ BROKER.FTMO         // "https://dxtrade.ftmo.com"
 - `client.getSymbolInfo(symbol)` — Get instrument info (volume limits, lot size)
 - `client.getSymbolLimits()` — Get order size limits and stop/limit distances for all symbols
 - `client.getInstruments(params?)` — Get all available instruments, optionally filtered by partial match (e.g. `{ type: "FOREX" }`)
+- `client.getOHLC(params)` — Fetch OHLC price bars for a symbol (resolution, range, maxBars, priceField)
 
 ### Trading
 
@@ -154,6 +158,7 @@ npm run example:assessments
 npm run example:assessments:btc
 npm run example:account
 npm run example:instruments
+npm run example:ohlc
 npm run example:instruments:forex
 npm run example:symbol
 npm run example:symbol:btc

package/dist/index.d.mts

@@ -12,11 +12,13 @@ declare const endpoints: {
     submitOrder: (base: string) => string;
     closePosition: (base: string) => string;
     assessments: (base: string) => string;
-    websocket: (base: string) => string;
+    websocket: (base: string, atmosphereId?: string | null) => string;
     tradeJournal: (base: string, params: {
         from: number;
         to: number;
     }) => string;
+    subscribeInstruments: (base: string) => string;
+    charts: (base: string) => string;
 };
 
 declare enum ORDER_TYPE {
@@ -37,11 +39,39 @@ declare enum TIF {
     DAY = "DAY",
     GTD = "GTD"
 }
+declare enum ERROR {
+    NO_SESSION = "NO_SESSION",
+    LOGIN_FAILED = "LOGIN_FAILED",
+    LOGIN_ERROR = "LOGIN_ERROR",
+    CSRF_NOT_FOUND = "CSRF_NOT_FOUND",
+    CSRF_ERROR = "CSRF_ERROR",
+    ACCOUNT_SWITCH_ERROR = "ACCOUNT_SWITCH_ERROR",
+    NO_SUGGESTIONS = "NO_SUGGESTIONS",
+    SUGGEST_ERROR = "SUGGEST_ERROR",
+    NO_SYMBOL_INFO = "NO_SYMBOL_INFO",
+    SYMBOL_INFO_ERROR = "SYMBOL_INFO_ERROR",
+    INSTRUMENTS_TIMEOUT = "INSTRUMENTS_TIMEOUT",
+    INSTRUMENTS_ERROR = "INSTRUMENTS_ERROR",
+    LIMITS_TIMEOUT = "LIMITS_TIMEOUT",
+    LIMITS_ERROR = "LIMITS_ERROR",
+    OHLC_TIMEOUT = "OHLC_TIMEOUT",
+    OHLC_ERROR = "OHLC_ERROR",
+    ORDER_ERROR = "ORDER_ERROR",
+    POSITION_CLOSE_ERROR = "POSITION_CLOSE_ERROR",
+    ACCOUNT_METRICS_TIMEOUT = "ACCOUNT_METRICS_TIMEOUT",
+    ACCOUNT_METRICS_ERROR = "ACCOUNT_METRICS_ERROR",
+    ACCOUNT_POSITIONS_TIMEOUT = "ACCOUNT_POSITIONS_TIMEOUT",
+    ACCOUNT_POSITIONS_ERROR = "ACCOUNT_POSITIONS_ERROR",
+    TRADE_JOURNAL_ERROR = "TRADE_JOURNAL_ERROR",
+    ASSESSMENTS_ERROR = "ASSESSMENTS_ERROR"
+}
 declare enum WS_MESSAGE {
     ACCOUNT_METRICS = "ACCOUNT_METRICS",
     ACCOUNTS = "ACCOUNTS",
     AVAILABLE_WATCHLISTS = "AVAILABLE_WATCHLISTS",
+    CHART_FEED_SUBTOPIC = "chartFeedSubtopic",
     INSTRUMENTS = "INSTRUMENTS",
+    INSTRUMENT_METRICS = "INSTRUMENT_METRICS",
     LIMITS = "LIMITS",
     MESSAGE = "MESSAGE",
     ORDERS = "ORDERS",
@@ -49,8 +79,14 @@ declare enum WS_MESSAGE {
     POSITION_CASH_TRANSFERS = "POSITION_CASH_TRANSFERS",
     PRIVATE_LAYOUT_NAMES = "PRIVATE_LAYOUT_NAMES",
     SHARED_PROPERTIES_MESSAGE = "SHARED_PROPERTIES_MESSAGE",
+    TRADE_STATUSES = "TRADE_STATUSES",
     USER_LOGIN_INFO = "USER_LOGIN_INFO"
 }
+declare namespace WS_MESSAGE {
+    enum SUBTOPIC {
+        BIG_CHART_COMPONENT = "BigChartComponentPresenter-4"
+    }
+}
 
 declare class DxtradeError extends Error {
     code: string;
@@ -238,6 +274,31 @@ declare namespace Instrument {
     }
 }
 
+declare namespace OHLC {
+    interface Params {
+        /** Symbol to fetch bars for (e.g. "EURUSD"). */
+        symbol: string;
+        /** Bar aggregation period in seconds (default: 60 = 1 min). Common values: 60 (1m), 300 (5m), 900 (15m), 1800 (30m), 3600 (1h), 14400 (4h), 86400 (1d). */
+        resolution?: number;
+        /** Lookback window in seconds from now (default: 432000 = 5 days). Determines how far back in history to fetch bars. */
+        range?: number;
+        /** Maximum number of bars to return (default: 3500). */
+        maxBars?: number;
+        /** Price field to use (default: "bid"). */
+        priceField?: "bid" | "ask";
+    }
+    interface Bar {
+        timestamp: number;
+        open: number;
+        high: number;
+        low: number;
+        close: number;
+        volume: number;
+        vwap: number;
+        time: number;
+    }
+}
+
 declare namespace Position {
     interface Get {
         uid: string;
@@ -356,6 +417,15 @@ declare class DxtradeClient {
     getInstruments(params?: Partial<Instrument.Info>): Promise<Instrument.Info[]>;
     /** Fetch PnL assessments for an instrument within a date range. */
     getAssessments(params: Assessments.Params): Promise<Assessments.Response>;
+    /**
+     * Fetch OHLC price bars for a symbol.
+     * @param params.symbol - Instrument symbol (e.g. "EURUSD")
+     * @param params.resolution - Bar period in seconds (default: 60 = 1 min)
+     * @param params.range - Lookback window in seconds (default: 432000 = 5 days)
+     * @param params.maxBars - Maximum bars to return (default: 3500)
+     * @param params.priceField - "bid" or "ask" (default: "bid")
+     */
+    getOHLC(params: OHLC.Params): Promise<OHLC.Bar[]>;
 }
 
-export { ACTION, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig, DxtradeError, ORDER_TYPE, SIDE, TIF, WS_MESSAGE, type WsPayload, endpoints };
+export { ACTION, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig, DxtradeError, ERROR, ORDER_TYPE, SIDE, TIF, WS_MESSAGE, type WsPayload, endpoints };

package/dist/index.d.ts

@@ -12,11 +12,13 @@ declare const endpoints: {
     submitOrder: (base: string) => string;
     closePosition: (base: string) => string;
     assessments: (base: string) => string;
-    websocket: (base: string) => string;
+    websocket: (base: string, atmosphereId?: string | null) => string;
     tradeJournal: (base: string, params: {
         from: number;
         to: number;
     }) => string;
+    subscribeInstruments: (base: string) => string;
+    charts: (base: string) => string;
 };
 
 declare enum ORDER_TYPE {
@@ -37,11 +39,39 @@ declare enum TIF {
     DAY = "DAY",
     GTD = "GTD"
 }
+declare enum ERROR {
+    NO_SESSION = "NO_SESSION",
+    LOGIN_FAILED = "LOGIN_FAILED",
+    LOGIN_ERROR = "LOGIN_ERROR",
+    CSRF_NOT_FOUND = "CSRF_NOT_FOUND",
+    CSRF_ERROR = "CSRF_ERROR",
+    ACCOUNT_SWITCH_ERROR = "ACCOUNT_SWITCH_ERROR",
+    NO_SUGGESTIONS = "NO_SUGGESTIONS",
+    SUGGEST_ERROR = "SUGGEST_ERROR",
+    NO_SYMBOL_INFO = "NO_SYMBOL_INFO",
+    SYMBOL_INFO_ERROR = "SYMBOL_INFO_ERROR",
+    INSTRUMENTS_TIMEOUT = "INSTRUMENTS_TIMEOUT",
+    INSTRUMENTS_ERROR = "INSTRUMENTS_ERROR",
+    LIMITS_TIMEOUT = "LIMITS_TIMEOUT",
+    LIMITS_ERROR = "LIMITS_ERROR",
+    OHLC_TIMEOUT = "OHLC_TIMEOUT",
+    OHLC_ERROR = "OHLC_ERROR",
+    ORDER_ERROR = "ORDER_ERROR",
+    POSITION_CLOSE_ERROR = "POSITION_CLOSE_ERROR",
+    ACCOUNT_METRICS_TIMEOUT = "ACCOUNT_METRICS_TIMEOUT",
+    ACCOUNT_METRICS_ERROR = "ACCOUNT_METRICS_ERROR",
+    ACCOUNT_POSITIONS_TIMEOUT = "ACCOUNT_POSITIONS_TIMEOUT",
+    ACCOUNT_POSITIONS_ERROR = "ACCOUNT_POSITIONS_ERROR",
+    TRADE_JOURNAL_ERROR = "TRADE_JOURNAL_ERROR",
+    ASSESSMENTS_ERROR = "ASSESSMENTS_ERROR"
+}
 declare enum WS_MESSAGE {
     ACCOUNT_METRICS = "ACCOUNT_METRICS",
     ACCOUNTS = "ACCOUNTS",
     AVAILABLE_WATCHLISTS = "AVAILABLE_WATCHLISTS",
+    CHART_FEED_SUBTOPIC = "chartFeedSubtopic",
     INSTRUMENTS = "INSTRUMENTS",
+    INSTRUMENT_METRICS = "INSTRUMENT_METRICS",
     LIMITS = "LIMITS",
     MESSAGE = "MESSAGE",
     ORDERS = "ORDERS",
@@ -49,8 +79,14 @@ declare enum WS_MESSAGE {
     POSITION_CASH_TRANSFERS = "POSITION_CASH_TRANSFERS",
     PRIVATE_LAYOUT_NAMES = "PRIVATE_LAYOUT_NAMES",
     SHARED_PROPERTIES_MESSAGE = "SHARED_PROPERTIES_MESSAGE",
+    TRADE_STATUSES = "TRADE_STATUSES",
     USER_LOGIN_INFO = "USER_LOGIN_INFO"
 }
+declare namespace WS_MESSAGE {
+    enum SUBTOPIC {
+        BIG_CHART_COMPONENT = "BigChartComponentPresenter-4"
+    }
+}
 
 declare class DxtradeError extends Error {
     code: string;
@@ -238,6 +274,31 @@ declare namespace Instrument {
     }
 }
 
+declare namespace OHLC {
+    interface Params {
+        /** Symbol to fetch bars for (e.g. "EURUSD"). */
+        symbol: string;
+        /** Bar aggregation period in seconds (default: 60 = 1 min). Common values: 60 (1m), 300 (5m), 900 (15m), 1800 (30m), 3600 (1h), 14400 (4h), 86400 (1d). */
+        resolution?: number;
+        /** Lookback window in seconds from now (default: 432000 = 5 days). Determines how far back in history to fetch bars. */
+        range?: number;
+        /** Maximum number of bars to return (default: 3500). */
+        maxBars?: number;
+        /** Price field to use (default: "bid"). */
+        priceField?: "bid" | "ask";
+    }
+    interface Bar {
+        timestamp: number;
+        open: number;
+        high: number;
+        low: number;
+        close: number;
+        volume: number;
+        vwap: number;
+        time: number;
+    }
+}
+
 declare namespace Position {
     interface Get {
         uid: string;
@@ -356,6 +417,15 @@ declare class DxtradeClient {
     getInstruments(params?: Partial<Instrument.Info>): Promise<Instrument.Info[]>;
     /** Fetch PnL assessments for an instrument within a date range. */
     getAssessments(params: Assessments.Params): Promise<Assessments.Response>;
+    /**
+     * Fetch OHLC price bars for a symbol.
+     * @param params.symbol - Instrument symbol (e.g. "EURUSD")
+     * @param params.resolution - Bar period in seconds (default: 60 = 1 min)
+     * @param params.range - Lookback window in seconds (default: 432000 = 5 days)
+     * @param params.maxBars - Maximum bars to return (default: 3500)
+     * @param params.priceField - "bid" or "ask" (default: "bid")
+     */
+    getOHLC(params: OHLC.Params): Promise<OHLC.Bar[]>;
 }
 
-export { ACTION, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig, DxtradeError, ORDER_TYPE, SIDE, TIF, WS_MESSAGE, type WsPayload, endpoints };
+export { ACTION, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig, DxtradeError, ERROR, ORDER_TYPE, SIDE, TIF, WS_MESSAGE, type WsPayload, endpoints };