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

    Interface InstrumentSymbol

    Complete instrument symbol definition from XTB.

    Represents detailed information about a financial instrument including identifiers, display names, trading parameters, and asset classification.

    const symbol: InstrumentSymbol = {
      name: 'CIG.PL',
      quoteId: 12345,
      instrumentId: 67890,
      idAssetClass: 9, // 9 = stocks
      displayName: 'CI Games SA',
      description: 'CI Games SA - game development company',
      fullDescription: 'CI Games SA - Polish video game developer and publisher',
      groupId: 6,
      searchGroup: 'Polish Stocks',
      precision: 2,
      lotMin: 1,
      lotStep: 1
    };
    interface InstrumentSymbol {
        description: string;
        displayName: string;
        fullDescription: string;
        groupId: number;
        hasDepth?: boolean;
        idAssetClass: number;
        instrumentId: number;
        instrumentTag?: string;
        lotMin: number;
        lotStep: number;
        name: string;
        precision: number;
        quoteId: number;
        searchGroup: string;
    }
    Index

    Properties

    description displayName fullDescription groupId hasDepth? idAssetClass instrumentId instrumentTag? lotMin lotStep name precision quoteId searchGroup

    Properties

    description: string

    Short description

    displayName: string

    Human-readable display name

    fullDescription: string

    Full detailed description

    groupId: number

    Group ID for symbol organization

    hasDepth?: boolean

    Whether market depth data is available

    idAssetClass: number

    Asset class ID (1=forex, 4=indices, 5=commodities, 9=stocks)

    instrumentId: number

    Unique instrument identifier

    instrumentTag?: string

    Optional instrument tag

    lotMin: number

    Minimum lot size

    lotStep: number

    Lot step increment

    name: string

    Symbol name (e.g., 'CIG.PL', 'AAPL.US')

    precision: number

    Price precision (decimal places)

    quoteId: number

    Quote ID for price data subscriptions

    searchGroup: string

    Search group category

    Settings

    Member Visibility

    On This Page

    Properties