aftermath-ts-sdk - v6.1.0
    Preparing search index...

    Interface PerpetualsMarketMetadata

    Display metadata for a market: ticker symbols, label, artwork, category and tags.

    Presentation data only — none of it affects pricing, margin or execution.

    interface PerpetualsMarketMetadata {
        category: string;
        collateralSymbol: string;
        description?: string;
        displayName?: string;
        image: string;
        symbol: string;
        tags?: string[];
    }
    Index
    category collateralSymbol description? displayName? image symbol tags?
    category: string

    The market's single top-level grouping, e.g. "Crypto" or "TradFi".

    Always names one of the categories returned by Perpetuals.getMarketsCategories. It is an opaque label resolved against that response rather than a fixed set, so new categories appear without an SDK release.

    collateralSymbol: string

    Collateral asset ticker, e.g. "USDC".

    description?: string

    Long-form blurb describing the market. Absent when unset.

    displayName?: string

    Long-form name, e.g. "Bitcoin". Absent when unset.

    image: string

    Icon location for the market, e.g. "/markets/btc.png".

    symbol: string

    Base asset ticker, e.g. "BTC" (not the "BTCUSD" pair symbol).

    tags?: string[]

    Second-tier filter labels within category. A market may carry several, and each one is declared under its own category by Perpetuals.getMarketsCategories.

    Absent or empty means the market shows only under its category's unfiltered view.

    Settings
    Member Visibility

    On This Page
    Properties