@danielgroen/dxtrade-api 1.0.20 → 1.0.22

package/README.md

@@ -21,17 +21,18 @@ npm install dxtrade-api
 
 - [x] Authentication & session management
 - [x] Submit orders (market, limit, stop)
-- [x] Positions (get & close)
-- [x] Account metrics & trade journal
+- [x] Get & cancel orders
+- [x] Positions (get, close, close all)
+- [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] PnL assessments
 - [x] Multi-broker support (FTMO, Eightcap, Lark Funding)
 - [x] Full TypeScript support
 - [ ] Batch orders
-- [ ] Close whole position helper
 - [ ] Modify existing orders
 - [ ] Real-time price streaming
-- [ ] Order history
 
 ## Quick Start
 
@@ -99,20 +100,27 @@ 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
 
 - `client.submitOrder(params)` — Submit an order and wait for WebSocket confirmation
+- `client.getOrders()` — Get all pending/open orders via WebSocket
+- `client.cancelOrder(orderChainId)` — Cancel a single pending order
+- `client.cancelAllOrders()` — Cancel all pending orders
 
 ### Positions
 
 - `client.getPositions()` — Get all open positions via WebSocket
-- `client.closePosition(params)` — Close a position
+- `client.closePosition(params)` — Close a position (supports partial closes via the quantity field)
+- `client.closeAllPositions()` — Close all open positions with market orders
+- `client.getPositionMetrics()` — Get position-level P&L metrics via WebSocket
 
 ### Account
 
 - `client.getAccountMetrics()` — Get account metrics (equity, balance, margin, open P&L, etc.)
 - `client.getTradeJournal({ from, to })` — Fetch trade journal entries for a date range (Unix timestamps)
+- `client.getTradeHistory({ from, to })` — Fetch trade history for a date range (Unix timestamps)
 
 ### Analytics
 
@@ -150,16 +158,21 @@ const client = new DxtradeClient({
 cp .env.example .env  # fill in credentials
 npm run example:connect
 npm run example:order
+npm run example:orders
 npm run example:positions
 npm run example:close-position
+npm run example:close-all-positions
+npm run example:position-metrics
 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
 npm run example:trade-journal
+npm run example:trade-history
 npm run example:debug
 ```
 

package/dist/index.d.mts

@@ -11,12 +11,19 @@ declare const endpoints: {
     instrumentInfo: (base: string, symbol: string, tzOffset: number) => string;
     submitOrder: (base: string) => string;
     closePosition: (base: string) => string;
+    cancelOrder: (base: string, accountId: string, orderChainId: number) => 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;
+    tradeHistory: (base: string, params: {
+        from: number;
+        to: number;
+    }) => string;
+    subscribeInstruments: (base: string) => string;
+    charts: (base: string) => string;
 };
 
 declare enum ORDER_TYPE {
@@ -37,20 +44,60 @@ 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",
+    ORDERS_TIMEOUT = "ORDERS_TIMEOUT",
+    ORDERS_ERROR = "ORDERS_ERROR",
+    CANCEL_ORDER_ERROR = "CANCEL_ORDER_ERROR",
+    POSITION_CLOSE_ERROR = "POSITION_CLOSE_ERROR",
+    POSITION_METRICS_TIMEOUT = "POSITION_METRICS_TIMEOUT",
+    POSITION_METRICS_ERROR = "POSITION_METRICS_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",
+    TRADE_HISTORY_ERROR = "TRADE_HISTORY_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",
     LIMITS = "LIMITS",
     MESSAGE = "MESSAGE",
     ORDERS = "ORDERS",
     POSITIONS = "POSITIONS",
+    POSITION_METRICS = "POSITION_METRICS",
     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;
@@ -58,6 +105,22 @@ declare class DxtradeError extends Error {
 }
 
 declare namespace Order {
+    interface Get {
+        account: string;
+        orderId: number;
+        orderCode: string;
+        version: number;
+        type: ORDER_TYPE;
+        instrument: string;
+        status: string;
+        finalStatus: boolean;
+        side: SIDE;
+        tif: TIF;
+        legs: Leg[];
+        issueTime: string;
+        transactionTime: string;
+        [key: string]: unknown;
+    }
     interface SubmitParams {
         symbol: string;
         side: SIDE;
@@ -171,6 +234,20 @@ interface WsPayload {
 }
 
 declare namespace Account {
+    interface TradeHistory {
+        orderId: number;
+        orderCode: string;
+        instrument: string;
+        side: string;
+        type: string;
+        status: string;
+        quantity: number;
+        filledQuantity: number;
+        price: number;
+        averagePrice: number;
+        time: string;
+        [key: string]: unknown;
+    }
     interface Metrics {
         availableFunds: number;
         marginCallLevel: number | string;
@@ -238,6 +315,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;
@@ -257,6 +359,14 @@ declare namespace Position {
         takeProfit: number | null;
         stopLoss: number | null;
     }
+    interface Metrics {
+        positionCode: string;
+        openPl: number;
+        openPlPerLot: number;
+        currentPrice: number;
+        convertedOpenPl: number;
+        [key: string]: unknown;
+    }
     interface Close {
         legs: {
             instrumentId: number;
@@ -337,12 +447,24 @@ declare class DxtradeClient {
      * Supports market, limit, and stop orders with optional stop loss and take profit.
      */
     submitOrder(params: Order.SubmitParams): Promise<Order.Update>;
+    /** Get all pending/open orders via WebSocket. */
+    getOrders(): Promise<Order.Get[]>;
+    /** Cancel a single pending order by its order chain ID. */
+    cancelOrder(orderChainId: number): Promise<void>;
+    /** Cancel all pending orders. */
+    cancelAllOrders(): Promise<void>;
     /** Get account metrics including equity, balance, margin, and open P&L. */
     getAccountMetrics(): Promise<Account.Metrics>;
     /** Get all open positions via WebSocket. */
     getPositions(): Promise<Position.Get[]>;
-    /** Close a position. */
+    /**
+     * Close a position. Supports partial closes by specifying a quantity smaller than the full position size.
+     */
     closePosition(position: Position.Close): Promise<void>;
+    /** Close all open positions with market orders. */
+    closeAllPositions(): Promise<void>;
+    /** Get position-level P&L metrics via WebSocket. */
+    getPositionMetrics(): Promise<Position.Metrics[]>;
     /**
      * Fetch trade journal entries for a date range.
      * @param params.from - Start timestamp (Unix ms)
@@ -352,10 +474,28 @@ declare class DxtradeClient {
         from: number;
         to: number;
     }): Promise<any>;
+    /**
+     * Fetch trade history for a date range.
+     * @param params.from - Start timestamp (Unix ms)
+     * @param params.to - End timestamp (Unix ms)
+     */
+    getTradeHistory(params: {
+        from: number;
+        to: number;
+    }): Promise<Account.TradeHistory[]>;
     /** Get all available instruments, optionally filtered by partial match (e.g. `{ type: "FOREX" }`). */
     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

@@ -11,12 +11,19 @@ declare const endpoints: {
     instrumentInfo: (base: string, symbol: string, tzOffset: number) => string;
     submitOrder: (base: string) => string;
     closePosition: (base: string) => string;
+    cancelOrder: (base: string, accountId: string, orderChainId: number) => 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;
+    tradeHistory: (base: string, params: {
+        from: number;
+        to: number;
+    }) => string;
+    subscribeInstruments: (base: string) => string;
+    charts: (base: string) => string;
 };
 
 declare enum ORDER_TYPE {
@@ -37,20 +44,60 @@ 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",
+    ORDERS_TIMEOUT = "ORDERS_TIMEOUT",
+    ORDERS_ERROR = "ORDERS_ERROR",
+    CANCEL_ORDER_ERROR = "CANCEL_ORDER_ERROR",
+    POSITION_CLOSE_ERROR = "POSITION_CLOSE_ERROR",
+    POSITION_METRICS_TIMEOUT = "POSITION_METRICS_TIMEOUT",
+    POSITION_METRICS_ERROR = "POSITION_METRICS_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",
+    TRADE_HISTORY_ERROR = "TRADE_HISTORY_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",
     LIMITS = "LIMITS",
     MESSAGE = "MESSAGE",
     ORDERS = "ORDERS",
     POSITIONS = "POSITIONS",
+    POSITION_METRICS = "POSITION_METRICS",
     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;
@@ -58,6 +105,22 @@ declare class DxtradeError extends Error {
 }
 
 declare namespace Order {
+    interface Get {
+        account: string;
+        orderId: number;
+        orderCode: string;
+        version: number;
+        type: ORDER_TYPE;
+        instrument: string;
+        status: string;
+        finalStatus: boolean;
+        side: SIDE;
+        tif: TIF;
+        legs: Leg[];
+        issueTime: string;
+        transactionTime: string;
+        [key: string]: unknown;
+    }
     interface SubmitParams {
         symbol: string;
         side: SIDE;
@@ -171,6 +234,20 @@ interface WsPayload {
 }
 
 declare namespace Account {
+    interface TradeHistory {
+        orderId: number;
+        orderCode: string;
+        instrument: string;
+        side: string;
+        type: string;
+        status: string;
+        quantity: number;
+        filledQuantity: number;
+        price: number;
+        averagePrice: number;
+        time: string;
+        [key: string]: unknown;
+    }
     interface Metrics {
         availableFunds: number;
         marginCallLevel: number | string;
@@ -238,6 +315,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;
@@ -257,6 +359,14 @@ declare namespace Position {
         takeProfit: number | null;
         stopLoss: number | null;
     }
+    interface Metrics {
+        positionCode: string;
+        openPl: number;
+        openPlPerLot: number;
+        currentPrice: number;
+        convertedOpenPl: number;
+        [key: string]: unknown;
+    }
     interface Close {
         legs: {
             instrumentId: number;
@@ -337,12 +447,24 @@ declare class DxtradeClient {
      * Supports market, limit, and stop orders with optional stop loss and take profit.
      */
     submitOrder(params: Order.SubmitParams): Promise<Order.Update>;
+    /** Get all pending/open orders via WebSocket. */
+    getOrders(): Promise<Order.Get[]>;
+    /** Cancel a single pending order by its order chain ID. */
+    cancelOrder(orderChainId: number): Promise<void>;
+    /** Cancel all pending orders. */
+    cancelAllOrders(): Promise<void>;
     /** Get account metrics including equity, balance, margin, and open P&L. */
     getAccountMetrics(): Promise<Account.Metrics>;
     /** Get all open positions via WebSocket. */
     getPositions(): Promise<Position.Get[]>;
-    /** Close a position. */
+    /**
+     * Close a position. Supports partial closes by specifying a quantity smaller than the full position size.
+     */
     closePosition(position: Position.Close): Promise<void>;
+    /** Close all open positions with market orders. */
+    closeAllPositions(): Promise<void>;
+    /** Get position-level P&L metrics via WebSocket. */
+    getPositionMetrics(): Promise<Position.Metrics[]>;
     /**
      * Fetch trade journal entries for a date range.
      * @param params.from - Start timestamp (Unix ms)
@@ -352,10 +474,28 @@ declare class DxtradeClient {
         from: number;
         to: number;
     }): Promise<any>;
+    /**
+     * Fetch trade history for a date range.
+     * @param params.from - Start timestamp (Unix ms)
+     * @param params.to - End timestamp (Unix ms)
+     */
+    getTradeHistory(params: {
+        from: number;
+        to: number;
+    }): Promise<Account.TradeHistory[]>;
     /** Get all available instruments, optionally filtered by partial match (e.g. `{ type: "FOREX" }`). */
     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 };