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

    Interface XLoginResult

    Login response data from successful authentication.

    Contains account information, available endpoints, and user details returned after successful CAS authentication.

    const loginResult: XLoginResult = {
    accountList: [
    {
    accountNo: 12345678,
    currency: 'PLN',
    endpointType: 'meta1'
    }
    ],
    endpointList: ['meta1', 'meta2'],
    userData: {
    name: 'John',
    surname: 'Smith'
    }
    };
    interface XLoginResult {
        accountList: {
            accountNo: number;
            currency: string;
            endpointType: string;
        }[];
        endpointList: string[];
        userData: { name: string; surname: string };
    }
    Index

    Properties

    accountList: { accountNo: number; currency: string; endpointType: string }[]

    List of available trading accounts

    Type Declaration

    • accountNo: number

      Account number

    • currency: string

      Account base currency

    • endpointType: string

      Endpoint type (server)

    endpointList: string[]

    Available server endpoints

    userData: { name: string; surname: string }

    User information

    Type Declaration

    • name: string

      User's first name

    • surname: string

      User's last name