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

    Interface ClientInfo

    Client information for registerClientInfo command.

    Must match xStation5 format exactly for authentication to succeed. This identifies the client application to XTB servers.

    const clientInfo: ClientInfo = {
      appName: 'xStation5',    // default; configurable via WSClientConfig.appName
      appVersion: '2.94.1',   // default; configurable via WSClientConfig.appVersion
      appBuildNumber: '0',
      device: 'Linux x86_64', // default; configurable via WSClientConfig.device
      osVersion: '',
      comment: 'Node.js WebSocket Client',
      apiVersion: '2.73.0',
      osType: 0,    // 0 = Other/Linux
      deviceType: 1 // 1 = Desktop
    };
    interface ClientInfo {
        apiVersion: string;
        appBuildNumber: string;
        appName: string;
        appVersion: string;
        comment: string;
        device: string;
        deviceType: number;
        osType: number;
        osVersion: string;
    }
    Index

    Properties

    apiVersion appBuildNumber appName appVersion comment device deviceType osType osVersion

    Properties

    apiVersion: string

    API version

    appBuildNumber: string

    Build number

    appName: string

    Application name (should be 'xStation5')

    appVersion: string

    Application version

    comment: string

    Optional comment

    device: string

    Device description

    deviceType: number

    Device type (1=Desktop, 2=Mobile, 3=Tablet)

    osType: number

    OS type (0=Other/Linux, 1=Windows, 2=Mac)

    osVersion: string

    Operating system version

    Settings

    Member Visibility

    On This Page

    Properties