Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

HFun Feed WebSocket API

Real-time order book data from Hyperliquid node infrastructure.

Overview

This server provides real-time order book data from Hyperliquid node infrastructure. It implements endpoints compatible with Hyperliquid's official API, with extensions.

AlphaHype Seats

Access to the API requires an AlphaHype seat. The seat system is an on-chain smart contract on the Hyper EVM with a limited number of seats available (currently 10).

How It Works

  1. Purchase a seat by depositing aHYPE tokens as collateral
  2. Whitelist your IP via the /ip/add#post-ipadd) endpoint
  3. Connect - authentication is automatic once your IP is whitelisted

Pricing Model

Seat fees are based on utilization - the more seats occupied, the higher the fee rate:

  • Fee rate scales linearly from a minimum to maximum rate
  • Fees accrue per second while you hold a seat
  • Higher utilization = higher fees for all seat holders

Collateral & Health

  • Your collateral must always cover your accrued fees (debt)
  • If your debt exceeds your collateral, your position becomes unhealthy
  • Unhealthy seats are automatically disconnected from the API
  • Unhealthy positions can be liquidated ("kicked"), forfeiting the collateral
  • Add collateral or repay fees to maintain a healthy position

Management

Seats can be purchased and managed on alphaticks.

Available Subscriptions

TypeDescription
l1BookTop of book (best bid/ask)
l2BookAggregated price levels (periodic snapshots)
l3BookOrder-level data, lightweight fields
l4BookOrder-level data, full details (triggers, TIF, etc.)
tradesReal-time trade stream
candleReal-time candlestick data
allMidsMid prices for all trading pairs
impactPriceImpact price calculations
orderUpdatesReal-time order status updates
userFillsReal-time fill notifications

Available Queries

TypeDescription
l3OrdersQuery L3 orders by price range
l4OrdersQuery L4 orders by price range