@danielgroen/dxtrade-api 1.0.0

package/README.md

@@ -0,0 +1,115 @@
+# DXTrade API Library
+
+<!-- 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/#/)
+
+TypeScript client library for the DXTrade trading API.
+
+## Install
+
+```bash
+npm install dxtrade-api
+```
+
+## Quick Start
+
+```ts
+import { DxtradeClient, OrderType, OrderSide, BROKER } from "dxtrade-api";
+
+const client = new DxtradeClient({
+  username: "your_username",
+  password: "your_password",
+  broker: "lark",
+  accountId: "optional_account_id",
+});
+
+await client.connect();
+
+const suggestions = await client.getSymbolSuggestions("EURUSD");
+const symbol = suggestions[0];
+
+const order = await client.submitOrder({
+  symbol: symbol.name,
+  side: OrderSide.BUY,
+  quantity: 0.01,
+  orderType: OrderType.MARKET,
+  instrumentId: symbol.id,
+});
+
+console.log(`Order ${order.orderId}: ${order.status}`);
+```
+
+## Configuration
+
+| 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"`) |
+| `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) |
+| `callbacks` | `DxtradeCallbacks` | No | Event callbacks |
+
+## Built-in Brokers
+
+```ts
+import { BROKER } from "dxtrade-api";
+
+BROKER.LARK      // "https://trade.gooeytrade.com"
+BROKER.EIGHTCAP  // "https://trader.dx-eightcap.com"
+```
+
+## API
+
+### Session
+
+- `client.connect()` — Login, fetch CSRF, WebSocket handshake, optional account switch
+- `client.login()` — Authenticate with broker
+- `client.fetchCsrf()` — Fetch CSRF token from broker page
+- `client.switchAccount(accountId)` — Switch to a specific account
+
+### Market Data
+
+- `client.getSymbolSuggestions(text)` — Search for symbols
+- `client.getSymbolInfo(symbol)` — Get instrument info (volume limits, lot size)
+
+### Trading
+
+- `client.submitOrder(params)` — Submit an order and wait for WebSocket confirmation
+
+### Analytics
+
+- `client.getAssessments(params)` — Fetch PnL assessments for a date range
+
+## Callbacks
+
+```ts
+const client = new DxtradeClient({
+  // ...
+  callbacks: {
+    onLogin: () => console.log("Logged in"),
+    onAccountSwitch: (id) => console.log(`Switched to ${id}`),
+    onOrderPlaced: (order) => console.log("Order placed", order),
+    onOrderUpdate: (update) => console.log("Order update", update),
+    onError: (err) => console.error(`[${err.code}] ${err.message}`),
+  },
+});
+```
+
+## Examples
+
+```bash
+cp .env.example .env  # fill in credentials
+npm run example:connect
+npm run example:order
+npm run example:assessments
+```
+
+## DXTrade API Docs
+
+https://demo.dx.trade/developers/#/
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,129 @@
+declare const BROKER: {
+    readonly LARK: "https://trade.gooeytrade.com";
+    readonly EIGHTCAP: "https://trader.dx-eightcap.com";
+};
+declare function resolveBrokerUrl(broker: string, customUrls?: Record<string, string>): string;
+
+declare const endpoints: {
+    login: (base: string) => string;
+    switchAccount: (base: string, id: string) => string;
+    suggest: (base: string, text: string) => string;
+    instrumentInfo: (base: string, symbol: string, tzOffset: number) => string;
+    submitOrder: (base: string) => string;
+    assessments: (base: string) => string;
+    websocket: (base: string) => string;
+};
+
+declare enum ORDER_TYPE {
+    MARKET = "MARKET",
+    LIMIT = "LIMIT",
+    STOP = "STOP"
+}
+declare enum SIDE {
+    BUY = "BUY",
+    SELL = "SELL"
+}
+declare enum ACTION {
+    OPENING = "OPENING",
+    CLOSING = "CLOSING"
+}
+
+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;
+}
+
+interface DxtradeConfig$1 {
+    username: string;
+    password: string;
+    broker: string;
+    accountId?: string;
+    brokerUrls?: Record<string, string>;
+    retries?: number;
+    debug?: boolean;
+    callbacks?: DxtradeCallbacks;
+}
+interface DxtradeCallbacks {
+    onError?: (error: DxtradeError) => void;
+    onLogin?: () => void;
+    onAccountSwitch?: (accountId: string) => void;
+    onOrderPlaced?: (order: OrderResponse) => void;
+    onOrderUpdate?: (order: OrderUpdate$1) => void;
+}
+
+interface SymbolSuggestion$1 {
+    id: number;
+    name: string;
+    [key: string]: unknown;
+}
+interface SymbolInfo$1 {
+    maxVolume: number;
+    minVolume: number;
+    volumeStep: number;
+    lotSize: number;
+    [key: string]: unknown;
+}
+
+interface AssessmentsParams$1 {
+    from: number;
+    to: number;
+    instrument: string;
+    subtype?: string | null;
+}
+interface AssessmentsResponse$1 {
+    totalPL?: number;
+    [key: string]: unknown;
+}
+
+declare class DxtradeClient {
+    private config;
+    private callbacks;
+    private cookies;
+    private csrf;
+    private baseUrl;
+    private retries;
+    private debug;
+    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;
+}
+
+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 };

package/dist/index.d.ts

@@ -0,0 +1,129 @@
+declare const BROKER: {
+    readonly LARK: "https://trade.gooeytrade.com";
+    readonly EIGHTCAP: "https://trader.dx-eightcap.com";
+};
+declare function resolveBrokerUrl(broker: string, customUrls?: Record<string, string>): string;
+
+declare const endpoints: {
+    login: (base: string) => string;
+    switchAccount: (base: string, id: string) => string;
+    suggest: (base: string, text: string) => string;
+    instrumentInfo: (base: string, symbol: string, tzOffset: number) => string;
+    submitOrder: (base: string) => string;
+    assessments: (base: string) => string;
+    websocket: (base: string) => string;
+};
+
+declare enum ORDER_TYPE {
+    MARKET = "MARKET",
+    LIMIT = "LIMIT",
+    STOP = "STOP"
+}
+declare enum SIDE {
+    BUY = "BUY",
+    SELL = "SELL"
+}
+declare enum ACTION {
+    OPENING = "OPENING",
+    CLOSING = "CLOSING"
+}
+
+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;
+}
+
+interface DxtradeConfig$1 {
+    username: string;
+    password: string;
+    broker: string;
+    accountId?: string;
+    brokerUrls?: Record<string, string>;
+    retries?: number;
+    debug?: boolean;
+    callbacks?: DxtradeCallbacks;
+}
+interface DxtradeCallbacks {
+    onError?: (error: DxtradeError) => void;
+    onLogin?: () => void;
+    onAccountSwitch?: (accountId: string) => void;
+    onOrderPlaced?: (order: OrderResponse) => void;
+    onOrderUpdate?: (order: OrderUpdate$1) => void;
+}
+
+interface SymbolSuggestion$1 {
+    id: number;
+    name: string;
+    [key: string]: unknown;
+}
+interface SymbolInfo$1 {
+    maxVolume: number;
+    minVolume: number;
+    volumeStep: number;
+    lotSize: number;
+    [key: string]: unknown;
+}
+
+interface AssessmentsParams$1 {
+    from: number;
+    to: number;
+    instrument: string;
+    subtype?: string | null;
+}
+interface AssessmentsResponse$1 {
+    totalPL?: number;
+    [key: string]: unknown;
+}
+
+declare class DxtradeClient {
+    private config;
+    private callbacks;
+    private cookies;
+    private csrf;
+    private baseUrl;
+    private retries;
+    private debug;
+    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;
+}
+
+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 };