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

    Interface WSAuthOptions

    Authentication options for WebSocket client.

    Supports multiple authentication methods depending on what credentials you have. The client will automatically perform the complete CAS authentication flow.

    // Method 1: Full login with email/password
    const authByCredentials: WSAuthOptions = {
      credentials: {
        email: 'user@example.com',
        password: 'your-password'
      }
    };

    // Method 2: Using existing TGT
    const authByTGT: WSAuthOptions = {
      tgt: 'TGT-123456-abcdef...'
    };

    // Method 3: Using existing service ticket
    const authByTicket: WSAuthOptions = {
      serviceTicket: 'ST-789012-ghijkl...'
    };
    interface WSAuthOptions {
        credentials?: { email: string; password: string };
        serviceTicket?: string;
        tgt?: string;
    }
    Index

    Properties

    credentials? serviceTicket? tgt?

    Properties

    credentials?: { email: string; password: string }

    Email/password credentials (will perform full CAS login flow)

    Type Declaration

    • email: string

      XTB account email

    • password: string

      XTB account password

    serviceTicket?: string

    Direct service ticket (if you already have one from CAS)

    tgt?: string

    Ticket Granting Ticket (if you have one, will be used to get service ticket)

    Settings

    Member Visibility

    On This Page

    Properties