aftermath-ts-sdk - v3.3.3
    Preparing search index...

    Interface PerpetualsWsUpdatesTopOfOrderbookSubscriptionType

    Websocket subscription payload for bucketed orderbook snapshots (top of orderbook) for a specific market.

    interface PerpetualsWsUpdatesTopOfOrderbookSubscriptionType {
        topOfOrderbook: {
            bucketsNumber: number;
            marketId: string;
            priceBucketSize: number;
        };
    }
    Index
    topOfOrderbook
    topOfOrderbook: {
        bucketsNumber: number;
        marketId: string;
        priceBucketSize: number;
    }

    Top-of-orderbook subscription discriminator and payload.

    Type Declaration

    • bucketsNumber: number

      Number of price buckets to return per side.

    • marketId: string

      Market object ID whose bucketed book is streamed.

    • priceBucketSize: number

      Price width of each orderbook bucket, in quote units.

    Settings
    Member Visibility

    On This Page
    Properties