Skip to content

Streams

Subscription client.

active_asset_ctx

Stream active asset context.

Parameters:

Name Type Description Default
coin str

Asset symbol.

required
References
Source code in pkg/src/hyperliquid/streams/active_asset_ctx.py
def active_asset_ctx(self, coin: str):
  """Stream active asset context.

  Args:
    coin: Asset symbol.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._active_asset_ctx_impl(coin))

active_asset_data

Stream active asset data for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
coin str

Asset symbol.

required
References
Source code in pkg/src/hyperliquid/streams/active_asset_data.py
def active_asset_data(self, user: str, coin: str):
  """Stream active asset data for a user.

  Args:
    user: Account address.
    coin: Asset symbol.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._active_asset_data_impl(user, coin))

all_mids

Stream mids for all coins.

Parameters:

Name Type Description Default
dex str | None

Perp dex name. Defaults to the empty string which represents the first perp dex.

None
References
Source code in pkg/src/hyperliquid/streams/all_mids.py
def all_mids(self, dex: str | None = None):
  """Stream mids for all coins.

  Args:
    dex: Perp dex name. Defaults to the empty string which represents the
      first perp dex.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._all_mids_impl(dex))

all_dexs_asset_ctxs

Stream asset contexts for all perp dexs.

Parameters:

Name Type Description Default
validate bool | None

Override response validation for this call. When omitted, the client-level validation setting is used.

None
References
Source code in pkg/src/hyperliquid/streams/all_dexs_asset_ctxs.py
def all_dexs_asset_ctxs(self, *, validate: bool | None = None):
  """Stream asset contexts for all perp dexs.

  Args:
    validate: Override response validation for this call. When omitted,
      the client-level validation setting is used.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions#subscriptions)
  """
  return StreamManager(lambda: self._all_dexs_asset_ctxs_impl(validate=validate))

bbo

Stream best-bid-offer updates.

Parameters:

Name Type Description Default
coin str

Asset symbol.

required
References
Source code in pkg/src/hyperliquid/streams/bbo.py
def bbo(self, coin: str):
  """Stream best-bid-offer updates.

  Args:
    coin: Asset symbol.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._bbo_impl(coin))

candle

Stream candle updates for a coin.

Parameters:

Name Type Description Default
coin str

Asset symbol.

required
interval str

Candle interval.

required
References
Source code in pkg/src/hyperliquid/streams/candle.py
def candle(self, coin: str, interval: str):
  """Stream candle updates for a coin.

  Args:
    coin: Asset symbol.
    interval: Candle interval.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._candle_impl(coin, interval))

clearinghouse_state

Stream clearinghouse state for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
dex str

Perp dex name.

required
References
Source code in pkg/src/hyperliquid/streams/clearinghouse_state.py
def clearinghouse_state(self, user: str, dex: str):
  """Stream clearinghouse state for a user.

  Args:
    user: Account address.
    dex: Perp dex name.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._clearinghouse_state_impl(user, dex))

l2_book

Stream L2 book updates.

Parameters:

Name Type Description Default
coin str

Asset symbol.

required
n_sig_figs int | None

Aggregate levels to significant figures.

None
mantissa int | None

Only allowed when n_sig_figs is 5.

None
References
Source code in pkg/src/hyperliquid/streams/l2_book.py
def l2_book(
  self, coin: str, *,
  n_sig_figs: int | None = None,
  mantissa: int | None = None
):
  """Stream L2 book updates.

  Args:
    coin: Asset symbol.
    n_sig_figs: Aggregate levels to significant figures.
    mantissa: Only allowed when `n_sig_figs` is 5.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions#subscription-messages)
  """
  return StreamManager(lambda: self._l2_book_impl(coin, n_sig_figs=n_sig_figs, mantissa=mantissa))

notification

Stream notifications for a user.

Parameters:

Name Type Description Default
user str

User address.

required
References
Source code in pkg/src/hyperliquid/streams/notification.py
def notification(self, user: str):
  """Stream notifications for a user.

  Args:
    user: User address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._notification_impl(user))

open_orders

Stream open orders for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
dex str

Perp dex name.

required
References
Source code in pkg/src/hyperliquid/streams/open_orders.py
def open_orders(self, user: str, dex: str):
  """Stream open orders for a user.

  Args:
    user: Account address.
    dex: Perp dex name.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._open_orders_impl(user, dex))

order_updates

Stream order updates for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/order_updates.py
def order_updates(self, user: str):
  """Stream order updates for a user.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._order_updates_impl(user))

trades

Stream trades for a coin.

Parameters:

Name Type Description Default
coin str

Asset symbol.

required
References
Source code in pkg/src/hyperliquid/streams/trades.py
def trades(self, coin: str):
  """Stream trades for a coin.

  Args:
    coin: Asset symbol.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._trades_impl(coin))

twap_states

Stream TWAP states for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
dex str

Perp dex name.

required
References
Source code in pkg/src/hyperliquid/streams/twap_states.py
def twap_states(self, user: str, dex: str):
  """Stream TWAP states for a user.

  Args:
    user: Account address.
    dex: Perp dex name.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._twap_states_impl(user, dex))

user_events

Stream user events.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/user_events.py
def user_events(self, user: str):
  """Stream user events.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._user_events_impl(user))

user_fills

Stream user fills.

Parameters:

Name Type Description Default
user str

Account address.

required
aggregate_by_time bool | None

Aggregate partial fills in the same block.

None
References
Source code in pkg/src/hyperliquid/streams/user_fills.py
def user_fills(self, user: str, *, aggregate_by_time: bool | None = None):
  """Stream user fills.

  Args:
    user: Account address.
    aggregate_by_time: Aggregate partial fills in the same block.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions)
  """
  return StreamManager(lambda: self._user_fills_impl(user, aggregate_by_time=aggregate_by_time))

user_fundings

Stream user funding updates.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/user_fundings.py
def user_fundings(self, user: str):
  """Stream user funding updates.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._user_fundings_impl(user))

user_non_funding_ledger_updates

Stream non-funding ledger updates.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/user_non_funding_ledger_updates.py
def user_non_funding_ledger_updates(self, user: str):
  """Stream non-funding ledger updates.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._user_non_funding_ledger_updates_impl(user))

user_twap_history

Stream TWAP history for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/user_twap_history.py
def user_twap_history(self, user: str):
  """Stream TWAP history for a user.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._user_twap_history_impl(user))

user_twap_slice_fills

Stream TWAP slice fills for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/user_twap_slice_fills.py
def user_twap_slice_fills(self, user: str):
  """Stream TWAP slice fills for a user.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._user_twap_slice_fills_impl(user))

web_data3

Stream WebData3 updates for a user.

Parameters:

Name Type Description Default
user str

Account address.

required
References
Source code in pkg/src/hyperliquid/streams/web_data3.py
def web_data3(self, user: str):
  """Stream WebData3 updates for a user.

  Args:
    user: Account address.

  References:
    - [Hyperliquid API docs](https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/websocket#subscriptions)
  """
  return StreamManager(lambda: self._web_data3_impl(user))