@danielgroen/dxtrade-api 1.0.7 → 1.0.9

package/README.md

@@ -1,9 +1,9 @@
-# DXTrade API
+# DXtrade API
 
 <!-- create image from ./public/logo-dxtrade.svg -->
-[![DXTrade API](https://raw.githubusercontent.com/danielgroen/dxtrade-api/master/public/logo-dxtrade.svg)](https://demo.dx.trade/developers/#/)
+[![DXtrade API](https://raw.githubusercontent.com/danielgroen/dxtrade-api/master/public/logo-dxtrade.svg)](https://demo.dx.trade/developers/#/)
 
-TypeScript client library for the DXTrade trading API based upon Nodejs.
+TypeScript client library for the DXtrade trading API based upon Nodejs.
 
 ## Install
 
@@ -19,7 +19,7 @@ import { DxtradeClient, OrderType, OrderSide, BROKER } from "dxtrade-api";
 const client = new DxtradeClient({
   username: "your_username",
   password: "your_password",
-  broker: "lark",
+  broker: "larkfunding",
   accountId: "optional_account_id",
 });
 
@@ -43,9 +43,9 @@ console.log(`Order ${order.orderId}: ${order.status}`);
 
 | Option | Type | Required | Description |
 |---|---|---|---|
-| `username` | `string` | Yes | DXTrade account username |
-| `password` | `string` | Yes | DXTrade account password |
-| `broker` | `string` | Yes | Broker identifier (e.g. `"lark"`, `"eightcap"`) |
+| `username` | `string` | Yes | DXtrade account username |
+| `password` | `string` | Yes | DXtrade account password |
+| `broker` | `string` | Yes | Broker identifier (e.g. `"larkfunding"`, `"eightcap"`) |
 | `accountId` | `string` | No | Account ID to auto-switch after login |
 | `brokerUrls` | `Record<string, string>` | No | Custom broker URL mapping |
 | `retries` | `number` | No | Retry count for failed requests (default: 3) |
@@ -106,7 +106,7 @@ npm run example:order
 npm run example:assessments
 ```
 
-## DXTrade API Docs
+## DXtrade API Docs
 
 https://demo.dx.trade/developers/#/
 

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 declare const BROKER: {
-    readonly LARK: "https://trade.gooeytrade.com";
+    readonly LARKFUNDING: "https://trade.gooeytrade.com";
     readonly EIGHTCAP: "https://trader.dx-eightcap.com";
 };
 declare function resolveBrokerUrl(broker: string, customUrls?: Record<string, string>): string;
@@ -27,103 +27,253 @@ declare enum ACTION {
     OPENING = "OPENING",
     CLOSING = "CLOSING"
 }
+declare enum TIF {
+    GTC = "GTC",
+    DAY = "DAY",
+    GTD = "GTD"
+}
+declare enum WS_MESSAGE {
+    ACCOUNT_METRICS = "ACCOUNT_METRICS",
+    ACCOUNTS = "ACCOUNTS",
+    AVAILABLE_WATCHLISTS = "AVAILABLE_WATCHLISTS",
+    INSTRUMENTS = "INSTRUMENTS",
+    LIMITS = "LIMITS",
+    MESSAGE = "MESSAGE",
+    ORDERS = "ORDERS",
+    POSITIONS = "POSITIONS",
+    POSITION_CASH_TRANSFERS = "POSITION_CASH_TRANSFERS",
+    PRIVATE_LAYOUT_NAMES = "PRIVATE_LAYOUT_NAMES",
+    SHARED_PROPERTIES_MESSAGE = "SHARED_PROPERTIES_MESSAGE",
+    USER_LOGIN_INFO = "USER_LOGIN_INFO"
+}
 
 declare class DxtradeError extends Error {
     code: string;
     constructor(code: string, message: string);
 }
 
-interface SubmitOrderParams$1 {
-    symbol: string;
-    side: SIDE;
-    quantity: number;
-    orderType: ORDER_TYPE;
-    price?: number;
-    instrumentId?: number;
-    stopLoss?: StopLossParams;
-    takeProfit?: TakeProfitParams;
-    positionEffect?: ACTION;
-}
-interface StopLossParams {
-    price?: number;
-    offset?: number;
-}
-interface TakeProfitParams {
-    price?: number;
-    offset?: number;
-}
-interface OrderResponse {
-    status: number;
-    data: unknown;
-}
-interface OrderUpdate$1 {
-    orderId: string;
-    status: string;
-    statusDescription?: string;
-    [key: string]: unknown;
+declare namespace Order {
+    interface SubmitParams {
+        symbol: string;
+        side: SIDE;
+        quantity: number;
+        orderType: ORDER_TYPE;
+        orderCode?: string;
+        price?: number;
+        instrumentId?: number;
+        positionEffect?: ACTION;
+        positionCode?: string;
+        tif?: TIF;
+        expireDate?: string;
+        stopLoss?: StopLoss;
+        takeProfit?: TakeProfit;
+        metadata?: Record<string, string>;
+    }
+    interface StopLoss {
+        price?: number;
+        offset?: number;
+    }
+    interface TakeProfit {
+        price?: number;
+        offset?: number;
+    }
+    interface Response {
+        orderId: number;
+        updateOrderId: number;
+    }
+    interface Update {
+        orderId: string;
+        status: string;
+        statusDescription?: string;
+        [key: string]: unknown;
+    }
+    interface Model {
+        account: string;
+        orderId: number;
+        orderCode: string;
+        version: number;
+        clientOrderId: string;
+        actionCode: string;
+        legCount: number;
+        type: ORDER_TYPE;
+        instrument: string;
+        status: string;
+        finalStatus: boolean;
+        legs: Leg[];
+        side: SIDE;
+        tif: TIF;
+        priceOffset?: number;
+        priceLink?: "TRIGGERED_STOP" | "TRIGGERED_LIMIT";
+        expireDate?: string;
+        marginRate?: number;
+        issueTime: string;
+        transactionTime: string;
+        links?: Link[];
+        executions?: Execution[];
+        cashTransactions?: CashTransaction[];
+        audit?: Audit;
+    }
+    interface Leg {
+        instrument: string;
+        positionEffect?: ACTION;
+        positionCode?: string;
+        price?: number;
+        legRatio: number;
+        quantity: number;
+        filledQuantity: number;
+        remainingQuantity: number;
+        averagePrice: number;
+    }
+    interface Link {
+        linkType: "PARENT" | "CHILD" | "OCO";
+        linkedOrder: string;
+        linkedClientOrderId: string;
+    }
+    interface Execution {
+        [key: string]: unknown;
+    }
+    interface CashTransaction {
+        [key: string]: unknown;
+    }
+    interface Audit {
+        IP?: string;
+        userAgent?: string;
+    }
 }
 
-interface DxtradeConfig$1 {
+interface DxtradeConfig {
     username: string;
     password: string;
     broker: string;
     accountId?: string;
     brokerUrls?: Record<string, string>;
     retries?: number;
-    debug?: boolean;
+    debug?: boolean | string;
     callbacks?: DxtradeCallbacks;
 }
 interface DxtradeCallbacks {
     onError?: (error: DxtradeError) => void;
     onLogin?: () => void;
     onAccountSwitch?: (accountId: string) => void;
-    onOrderPlaced?: (order: OrderResponse) => void;
-    onOrderUpdate?: (order: OrderUpdate$1) => void;
+    onOrderPlaced?: (order: Order.Response) => void;
+    onOrderUpdate?: (order: Order.Update) => void;
 }
 
-interface SymbolSuggestion$1 {
-    id: number;
-    name: string;
-    [key: string]: unknown;
+interface WsPayload {
+    accountId: string | null;
+    body: unknown;
+    type: string;
 }
-interface SymbolInfo$1 {
-    maxVolume: number;
-    minVolume: number;
-    volumeStep: number;
-    lotSize: number;
-    [key: string]: unknown;
+
+declare namespace Account {
+    interface Metrics {
+        availableFunds: number;
+        marginCallLevel: number | string;
+        riskLevel: number;
+        openPl: number;
+        cashBalance: number;
+        equity: number;
+        conversionRate: number;
+        initialMargin: number;
+        availableBalance: number;
+        reverseRiskLevel: number | string;
+        [key: string]: unknown;
+    }
 }
 
-interface AssessmentsParams$1 {
-    from: number;
-    to: number;
-    instrument: string;
-    subtype?: string | null;
+declare namespace Assessments {
+    interface Params {
+        from: number;
+        to: number;
+        instrument: string;
+        subtype?: string | null;
+    }
+    interface Response {
+        totalPL?: number;
+        [key: string]: unknown;
+    }
 }
-interface AssessmentsResponse$1 {
-    totalPL?: number;
-    [key: string]: unknown;
+
+declare namespace Instrument {
+    interface Info {
+        id: number;
+        symbol: string;
+        description: string;
+        type: string;
+        subtype: string;
+        currency: string;
+        currencyPrecision: number;
+        precision: number;
+        pipsSize: number;
+        quantityIncrement: number;
+        quantityPrecision: number;
+        priceIncrement: number;
+        version: number;
+        priceIncrementsTO: {
+            priceIncrements: number[];
+            pricePrecisions: number[];
+            bondFraction: boolean;
+        };
+        lotSize: number;
+        baseCurrency: string | null;
+        lotName: string | null;
+        multiplier: number;
+        open: boolean;
+        expiration: string | null;
+        firstNoticeDate: string | null;
+        lastTradeDate: string | null;
+        underlying: string | null;
+        mmy: string | null;
+        optionParametersTO: unknown;
+        unitName: string | null;
+        additionalFields: unknown;
+        additionalObject: unknown;
+        currencyParametersTO: unknown;
+        tradingHours: string;
+    }
+}
+
+declare namespace Symbol {
+    interface Suggestion {
+        id: number;
+        name: string;
+        [key: string]: unknown;
+    }
+    interface Info {
+        maxVolume: number;
+        minVolume: number;
+        volumeStep: number;
+        lotSize: number;
+        [key: string]: unknown;
+    }
+    interface Limits {
+        symbol: string;
+        instrumentId: number;
+        limitStopDistanceType: string;
+        limitStopDistance: number;
+        limitStopDistanceInPercentOfSpread: number;
+        minOrderSize: number;
+        minOrderSizeBypass: boolean;
+        maxOrderSize: number;
+        minOrderIncrement: number;
+        limitType: string;
+    }
 }
 
 declare class DxtradeClient {
-    private config;
-    private callbacks;
-    private cookies;
-    private csrf;
-    private baseUrl;
-    private retries;
-    private debug;
+    private _ctx;
     constructor(config: DxtradeConfig);
     login(): Promise<void>;
     fetchCsrf(): Promise<void>;
     switchAccount(accountId: string): Promise<void>;
-    getSymbolSuggestions(text: string): Promise<SymbolSuggestion[]>;
-    getSymbolInfo(symbol: string): Promise<SymbolInfo>;
-    submitOrder(params: SubmitOrderParams): Promise<OrderUpdate>;
-    getAssessments(params: AssessmentsParams): Promise<AssessmentsResponse>;
     connect(): Promise<void>;
-    private ensureSession;
-    private throwError;
+    getSymbolSuggestions(text: string): Promise<Symbol.Suggestion[]>;
+    getSymbolInfo(symbol: string): Promise<Symbol.Info>;
+    getSymbolLimits(): Promise<Symbol.Limits[]>;
+    submitOrder(params: Order.SubmitParams): Promise<Order.Update>;
+    getAccountMetrics(): Promise<Account.Metrics>;
+    getInstruments(params?: Partial<Instrument.Info>): Promise<Instrument.Info[]>;
+    getAssessments(params: Assessments.Params): Promise<Assessments.Response>;
 }
 
-export { ACTION, type AssessmentsParams$1 as AssessmentsParams, type AssessmentsResponse$1 as AssessmentsResponse, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig$1 as DxtradeConfig, DxtradeError, ORDER_TYPE, type OrderResponse, type OrderUpdate$1 as OrderUpdate, SIDE, type StopLossParams, type SubmitOrderParams$1 as SubmitOrderParams, type SymbolInfo$1 as SymbolInfo, type SymbolSuggestion$1 as SymbolSuggestion, type TakeProfitParams, endpoints, resolveBrokerUrl };
+export { ACTION, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig, DxtradeError, ORDER_TYPE, SIDE, TIF, WS_MESSAGE, type WsPayload, endpoints, resolveBrokerUrl };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 declare const BROKER: {
-    readonly LARK: "https://trade.gooeytrade.com";
+    readonly LARKFUNDING: "https://trade.gooeytrade.com";
     readonly EIGHTCAP: "https://trader.dx-eightcap.com";
 };
 declare function resolveBrokerUrl(broker: string, customUrls?: Record<string, string>): string;
@@ -27,103 +27,253 @@ declare enum ACTION {
     OPENING = "OPENING",
     CLOSING = "CLOSING"
 }
+declare enum TIF {
+    GTC = "GTC",
+    DAY = "DAY",
+    GTD = "GTD"
+}
+declare enum WS_MESSAGE {
+    ACCOUNT_METRICS = "ACCOUNT_METRICS",
+    ACCOUNTS = "ACCOUNTS",
+    AVAILABLE_WATCHLISTS = "AVAILABLE_WATCHLISTS",
+    INSTRUMENTS = "INSTRUMENTS",
+    LIMITS = "LIMITS",
+    MESSAGE = "MESSAGE",
+    ORDERS = "ORDERS",
+    POSITIONS = "POSITIONS",
+    POSITION_CASH_TRANSFERS = "POSITION_CASH_TRANSFERS",
+    PRIVATE_LAYOUT_NAMES = "PRIVATE_LAYOUT_NAMES",
+    SHARED_PROPERTIES_MESSAGE = "SHARED_PROPERTIES_MESSAGE",
+    USER_LOGIN_INFO = "USER_LOGIN_INFO"
+}
 
 declare class DxtradeError extends Error {
     code: string;
     constructor(code: string, message: string);
 }
 
-interface SubmitOrderParams$1 {
-    symbol: string;
-    side: SIDE;
-    quantity: number;
-    orderType: ORDER_TYPE;
-    price?: number;
-    instrumentId?: number;
-    stopLoss?: StopLossParams;
-    takeProfit?: TakeProfitParams;
-    positionEffect?: ACTION;
-}
-interface StopLossParams {
-    price?: number;
-    offset?: number;
-}
-interface TakeProfitParams {
-    price?: number;
-    offset?: number;
-}
-interface OrderResponse {
-    status: number;
-    data: unknown;
-}
-interface OrderUpdate$1 {
-    orderId: string;
-    status: string;
-    statusDescription?: string;
-    [key: string]: unknown;
+declare namespace Order {
+    interface SubmitParams {
+        symbol: string;
+        side: SIDE;
+        quantity: number;
+        orderType: ORDER_TYPE;
+        orderCode?: string;
+        price?: number;
+        instrumentId?: number;
+        positionEffect?: ACTION;
+        positionCode?: string;
+        tif?: TIF;
+        expireDate?: string;
+        stopLoss?: StopLoss;
+        takeProfit?: TakeProfit;
+        metadata?: Record<string, string>;
+    }
+    interface StopLoss {
+        price?: number;
+        offset?: number;
+    }
+    interface TakeProfit {
+        price?: number;
+        offset?: number;
+    }
+    interface Response {
+        orderId: number;
+        updateOrderId: number;
+    }
+    interface Update {
+        orderId: string;
+        status: string;
+        statusDescription?: string;
+        [key: string]: unknown;
+    }
+    interface Model {
+        account: string;
+        orderId: number;
+        orderCode: string;
+        version: number;
+        clientOrderId: string;
+        actionCode: string;
+        legCount: number;
+        type: ORDER_TYPE;
+        instrument: string;
+        status: string;
+        finalStatus: boolean;
+        legs: Leg[];
+        side: SIDE;
+        tif: TIF;
+        priceOffset?: number;
+        priceLink?: "TRIGGERED_STOP" | "TRIGGERED_LIMIT";
+        expireDate?: string;
+        marginRate?: number;
+        issueTime: string;
+        transactionTime: string;
+        links?: Link[];
+        executions?: Execution[];
+        cashTransactions?: CashTransaction[];
+        audit?: Audit;
+    }
+    interface Leg {
+        instrument: string;
+        positionEffect?: ACTION;
+        positionCode?: string;
+        price?: number;
+        legRatio: number;
+        quantity: number;
+        filledQuantity: number;
+        remainingQuantity: number;
+        averagePrice: number;
+    }
+    interface Link {
+        linkType: "PARENT" | "CHILD" | "OCO";
+        linkedOrder: string;
+        linkedClientOrderId: string;
+    }
+    interface Execution {
+        [key: string]: unknown;
+    }
+    interface CashTransaction {
+        [key: string]: unknown;
+    }
+    interface Audit {
+        IP?: string;
+        userAgent?: string;
+    }
 }
 
-interface DxtradeConfig$1 {
+interface DxtradeConfig {
     username: string;
     password: string;
     broker: string;
     accountId?: string;
     brokerUrls?: Record<string, string>;
     retries?: number;
-    debug?: boolean;
+    debug?: boolean | string;
     callbacks?: DxtradeCallbacks;
 }
 interface DxtradeCallbacks {
     onError?: (error: DxtradeError) => void;
     onLogin?: () => void;
     onAccountSwitch?: (accountId: string) => void;
-    onOrderPlaced?: (order: OrderResponse) => void;
-    onOrderUpdate?: (order: OrderUpdate$1) => void;
+    onOrderPlaced?: (order: Order.Response) => void;
+    onOrderUpdate?: (order: Order.Update) => void;
 }
 
-interface SymbolSuggestion$1 {
-    id: number;
-    name: string;
-    [key: string]: unknown;
+interface WsPayload {
+    accountId: string | null;
+    body: unknown;
+    type: string;
 }
-interface SymbolInfo$1 {
-    maxVolume: number;
-    minVolume: number;
-    volumeStep: number;
-    lotSize: number;
-    [key: string]: unknown;
+
+declare namespace Account {
+    interface Metrics {
+        availableFunds: number;
+        marginCallLevel: number | string;
+        riskLevel: number;
+        openPl: number;
+        cashBalance: number;
+        equity: number;
+        conversionRate: number;
+        initialMargin: number;
+        availableBalance: number;
+        reverseRiskLevel: number | string;
+        [key: string]: unknown;
+    }
 }
 
-interface AssessmentsParams$1 {
-    from: number;
-    to: number;
-    instrument: string;
-    subtype?: string | null;
+declare namespace Assessments {
+    interface Params {
+        from: number;
+        to: number;
+        instrument: string;
+        subtype?: string | null;
+    }
+    interface Response {
+        totalPL?: number;
+        [key: string]: unknown;
+    }
 }
-interface AssessmentsResponse$1 {
-    totalPL?: number;
-    [key: string]: unknown;
+
+declare namespace Instrument {
+    interface Info {
+        id: number;
+        symbol: string;
+        description: string;
+        type: string;
+        subtype: string;
+        currency: string;
+        currencyPrecision: number;
+        precision: number;
+        pipsSize: number;
+        quantityIncrement: number;
+        quantityPrecision: number;
+        priceIncrement: number;
+        version: number;
+        priceIncrementsTO: {
+            priceIncrements: number[];
+            pricePrecisions: number[];
+            bondFraction: boolean;
+        };
+        lotSize: number;
+        baseCurrency: string | null;
+        lotName: string | null;
+        multiplier: number;
+        open: boolean;
+        expiration: string | null;
+        firstNoticeDate: string | null;
+        lastTradeDate: string | null;
+        underlying: string | null;
+        mmy: string | null;
+        optionParametersTO: unknown;
+        unitName: string | null;
+        additionalFields: unknown;
+        additionalObject: unknown;
+        currencyParametersTO: unknown;
+        tradingHours: string;
+    }
+}
+
+declare namespace Symbol {
+    interface Suggestion {
+        id: number;
+        name: string;
+        [key: string]: unknown;
+    }
+    interface Info {
+        maxVolume: number;
+        minVolume: number;
+        volumeStep: number;
+        lotSize: number;
+        [key: string]: unknown;
+    }
+    interface Limits {
+        symbol: string;
+        instrumentId: number;
+        limitStopDistanceType: string;
+        limitStopDistance: number;
+        limitStopDistanceInPercentOfSpread: number;
+        minOrderSize: number;
+        minOrderSizeBypass: boolean;
+        maxOrderSize: number;
+        minOrderIncrement: number;
+        limitType: string;
+    }
 }
 
 declare class DxtradeClient {
-    private config;
-    private callbacks;
-    private cookies;
-    private csrf;
-    private baseUrl;
-    private retries;
-    private debug;
+    private _ctx;
     constructor(config: DxtradeConfig);
     login(): Promise<void>;
     fetchCsrf(): Promise<void>;
     switchAccount(accountId: string): Promise<void>;
-    getSymbolSuggestions(text: string): Promise<SymbolSuggestion[]>;
-    getSymbolInfo(symbol: string): Promise<SymbolInfo>;
-    submitOrder(params: SubmitOrderParams): Promise<OrderUpdate>;
-    getAssessments(params: AssessmentsParams): Promise<AssessmentsResponse>;
     connect(): Promise<void>;
-    private ensureSession;
-    private throwError;
+    getSymbolSuggestions(text: string): Promise<Symbol.Suggestion[]>;
+    getSymbolInfo(symbol: string): Promise<Symbol.Info>;
+    getSymbolLimits(): Promise<Symbol.Limits[]>;
+    submitOrder(params: Order.SubmitParams): Promise<Order.Update>;
+    getAccountMetrics(): Promise<Account.Metrics>;
+    getInstruments(params?: Partial<Instrument.Info>): Promise<Instrument.Info[]>;
+    getAssessments(params: Assessments.Params): Promise<Assessments.Response>;
 }
 
-export { ACTION, type AssessmentsParams$1 as AssessmentsParams, type AssessmentsResponse$1 as AssessmentsResponse, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig$1 as DxtradeConfig, DxtradeError, ORDER_TYPE, type OrderResponse, type OrderUpdate$1 as OrderUpdate, SIDE, type StopLossParams, type SubmitOrderParams$1 as SubmitOrderParams, type SymbolInfo$1 as SymbolInfo, type SymbolSuggestion$1 as SymbolSuggestion, type TakeProfitParams, endpoints, resolveBrokerUrl };
+export { ACTION, BROKER, type DxtradeCallbacks, DxtradeClient, type DxtradeConfig, DxtradeError, ORDER_TYPE, SIDE, TIF, WS_MESSAGE, type WsPayload, endpoints, resolveBrokerUrl };