Enum Subscription 

pub enum Subscription {
    AllMids {
        dex: String,
    },
    Notification {
        user: Address,
    },
    WebData3 {
        user: Address,
    },
    TwapStates {
        user: Address,
        dex: String,
    },
    ClearinghouseState {
        user: Address,
        dex: String,
    },
    OpenOrders {
        user: Address,
        dex: String,
    },
    Candle {
        coin: String,
        interval: Interval,
    },
    L2Book {
        coin: String,
        n_sig_figs: Option<u8>,
        mantissa: Option<u8>,
        fast: bool,
    },
    Trades {
        coin: String,
    },
    OrderUpdates {
        user: Address,
    },
    UserEvents {
        user: Address,
    },
    UserFills {
        user: Address,
        aggregate_by_time: bool,
    },
    UserFundings {
        user: Address,
    },
    UserNonFundingLedgerUpdates {
        user: Address,
    },
    ActiveAssetCtx {
        coin: String,
    },
    ActiveAssetData {
        user: Address,
        coin: String,
    },
    UserTwapSliceFills {
        user: Address,
    },
    UserTwapHistory {
        user: Address,
    },
    Bbo {
        coin: String,
    },
    SpotState {
        user: Address,
        ignore_portfolio_margin: bool,
    },
    AllDexsClearinghouseState {
        user: Address,
    },
    AllDexsAssetCtxs,
    OutcomeMetaUpdates,
    FastAssetCtxs,
    AssetCtxs {
        dex: String,
    },
    SpotAssetCtxs,
    UserHistoricalOrders {
        user: Address,
    },
}

One feed. A coin is spelled as the venue spells it: BTC, xyz:SP500 (HIP-3), @107 or PURR/USDC (spot), #14720 (an outcome side). A dex of "" is the first perp dex.

Variants

AllMids

Every coin’s mid on one perp dex. The first dex’s also carries spot and outcome mids.

Fields

dex: String

Notification

Short texts for the account: fills, liquidations.

Fields

user: Address

WebData3

The account as Hyperliquid’s own frontend reads it.

Fields

user: Address

TwapStates

Fields

user: Address

dex: String

ClearinghouseState

Fields

user: Address

dex: String

OpenOrders

Fields

user: Address

dex: String

Candle

Fields

coin: String

interval: Interval

L2Book

n_sig_figs groups levels to 2 to 5 significant figures; mantissa (1, 2 or 5) groups further, with 5 figures only. fast gives 5 levels a side more often, not 20.

Fields

coin: String

n_sig_figs: Option<u8>

mantissa: Option<u8>

fast: bool

Trades

Fields

coin: String

OrderUpdates

Fields

user: Address

UserEvents

Its data comes on the channel user.

Fields

user: Address

UserFills

aggregate_by_time merges the partial fills of one crossing order.

Fields

user: Address

aggregate_by_time: bool

UserFundings

Fields

user: Address

UserNonFundingLedgerUpdates

Fields

user: Address

ActiveAssetCtx

A perp’s context; a spot pair’s or an outcome side’s comes on activeSpotAssetCtx.

Fields

coin: String

ActiveAssetData

What the account may trade on a perp. Perps only.

Fields

user: Address

coin: String

UserTwapSliceFills

Fields

user: Address

UserTwapHistory

Fields

user: Address

Bbo

The best bid and offer, sent only when one of them moves.

Fields

coin: String

SpotState

The docs name the option isPortfolioMargin; the venue ignores that and echoes ignorePortfolioMargin, which is what it reads.

Fields

user: Address

ignore_portfolio_margin: bool

AllDexsClearinghouseState

Fields

user: Address

AllDexsAssetCtxs

Every perp dex’s contexts in one frame.

OutcomeMetaUpdates

Changes to outcomeMeta, sent only when something changes.

FastAssetCtxs

Mark and mid changes, base64 of raw DEFLATE.

AssetCtxs

One perp dex’s contexts. In @nktkas/hyperliquid, not on the docs’ list.

Fields

dex: String

SpotAssetCtxs

Every spot and outcome context. In @nktkas/hyperliquid, not on the docs’ list.

UserHistoricalOrders

Orders and what became of them. In @nktkas/hyperliquid, not on the docs’ list.

Fields

user: Address

Implementations

impl Subscription

pub const fn kind(&self) -> &'static str

Its type.

pub fn channel(&self) -> &'static str

The channel its data comes on: its type, except userEvents (on user) and a spot or outcome coin’s activeAssetCtx (on activeSpotAssetCtx), so matching on the name sent would never fire.

pub const fn user(&self) -> Option<Address>

The account a user subscription follows. The venue allows ten across an IP’s subscriptions.

pub fn coin(&self) -> Option<&str>

The coin it follows, for the subscriptions that follow one.

pub fn to_json(&self) -> Json

The object a subscribe or unsubscribe frame carries: keys in the docs’ order, optional ones last and only when set, as the Python SDK sends them. The venue echoes left out options filled in (fast: false, dex: ""), and Subscription::parse reads that echo back to the same subscription.

pub fn check(&self) -> Result<(), BadSubscription>

Whether the venue would take it: a coin is named, and a book’s grouping is one the info docs allow. The venue drops the whole socket for some subscriptions it cannot serve (a bbo of an unknown coin), so a coin should come from the venue’s own lists.

pub fn parse(json: &Json) -> Result<Subscription, BadSubscription>

Reads a subscription object, in any key order, as the venue echoes it or as it was sent. Keys it does not know are passed over; null, false and "" read as left out.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Subscription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Subscription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

The object as one line of JSON.

impl Eq for Subscription

impl Hash for Subscription

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Subscription

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Subscription