xtb-api-unofficial - v0.1.0
    Preparing search index...

    Interface WSClientConfig

    WebSocket client configuration.

    Defines connection parameters, account information, and authentication options for connecting to XTB's WebSocket API.

    // Demo account configuration
    const demoConfig: WSClientConfig = {
      url: 'wss://api5demoa.x-station.eu/v1/xstation',
      accountNumber: 12345678,
      auth: {
        credentials: {
          email: 'demo@example.com',
          password: 'demo-password'
        }
      }
    };

    // Real account configuration
    const realConfig: WSClientConfig = {
      url: 'wss://api5reala.x-station.eu/v1/xstation',
      accountNumber: 87654321,
      pingInterval: 30000,
      auth: {
        credentials: {
          email: 'real@example.com',
          password: 'real-password'
        }
      }
    };
    interface WSClientConfig {
        accountNumber: number;
        appName?: string;
        appVersion?: string;
        auth?: WSAuthOptions;
        autoReconnect?: boolean;
        device?: string;
        endpoint?: string;
        maxReconnectDelay?: number;
        pingInterval?: number;
        url: string;
    }
    Index

    Properties

    accountNumber appName? appVersion? auth? autoReconnect? device? endpoint? maxReconnectDelay? pingInterval? url

    Properties

    accountNumber: number

    XTB account number

    appName?: string

    Application name sent in registerClientInfo (default: 'xStation5')

    appVersion?: string

    Application version sent in registerClientInfo (default: '2.94.1')

    auth?: WSAuthOptions

    Authentication options (required for most operations)

    autoReconnect?: boolean

    Auto-reconnect on disconnect (default: true)

    device?: string

    Device string sent in registerClientInfo (default: 'Linux x86_64')

    endpoint?: string

    Server endpoint (default: 'meta1')

    maxReconnectDelay?: number

    Maximum reconnection delay in milliseconds (default: 30000)

    pingInterval?: number

    Ping interval in milliseconds (default: 10000)

    url: string

    WebSocket URL (demo: wss://api5demoa.x-station.eu/v1/xstation, real: wss://api5reala.x-station.eu/v1/xstation)

    Settings

    Member Visibility

    On This Page

    Properties