View Source Hyperliquid.Api.Subscription.FastAssetCtxs (hyperliquid v0.4.1)

WebSocket subscription for low-latency mark and mid price updates.

A trimmed-down counterpart to assetCtxs: each event is a map of coin to a context carrying only markPx and midPx, either of which may be absent, and midPx may be explicitly null when there is no two-sided market.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/websocket/subscriptions

Usage

{:ok, request} = FastAssetCtxs.build_request()
# => {:ok, %{type: "fastAssetCtxs"}}

Summary

Types

request_params()

t()

Functions

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this subscription.

__subscription_info__()

Returns metadata about this subscription endpoint.

build_cache_key(event_data)

Build a cache key from event data using the configured pattern.

build_request(params \\ %{})

Build a subscription request.

cache_enabled?()

Returns true if cache storage is enabled.

cache_fields()

Returns the configured cache fields for partial storage, or nil for all fields.

cache_ttl()

Returns the cache TTL if configured.

changeset(event \\ %__MODULE__{}, attrs)

coins(arg1)

Coins present in this event.

generate_subscription_key(params)

Generate a unique subscription key for this parameter set.

mark_px(event, coin)

Mark price for a coin.

mid_px(event, coin)

Mid price for a coin.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_fields()

Returns the configured postgres fields for partial storage, or nil for all fields.

postgres_table()

Returns the postgres table name if configured (primary table for legacy support).

storage_enabled?()

Returns true if any storage backend is enabled.

Types

request_params()

@type request_params() :: %{}

t()

@type t() :: %Hyperliquid.Api.Subscription.FastAssetCtxs{ctxs: map()}

Functions

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this subscription.

__subscription_info__()

Returns metadata about this subscription endpoint.

build_cache_key(event_data)

Build a cache key from event data using the configured pattern.

Returns nil if cache is not enabled or no pattern is configured.

build_request(params \\ %{})

@spec build_request(map()) :: {:ok, map()}

Build a subscription request.

Returns

{:ok, request_map} - Subscription request

cache_enabled?()

Returns true if cache storage is enabled.

cache_fields()

Returns the configured cache fields for partial storage, or nil for all fields.

cache_ttl()

Returns the cache TTL if configured.

changeset(event \\ %MODULE{}, attrs)

@spec changeset(t(), map()) :: Ecto.Changeset.t()

coins(arg1)

@spec coins(t() | map()) :: [String.t()]

Coins present in this event.

Parameters

event: The subscription event

Returns

List of coin names

generate_subscription_key(params)

@spec generate_subscription_key(map()) :: String.t()

Generate a unique subscription key for this parameter set.

Parameters

params - Map of subscription parameters

Returns

String key that uniquely identifies this subscription variant.

mark_px(event, coin)

@spec mark_px(t() | map(), String.t()) :: {:ok, String.t()} | {:error, :not_found}

Mark price for a coin.

Parameters

event: The subscription event
coin: Coin name

Returns

{:ok, String.t()} if present
{:error, :not_found} otherwise

mid_px(event, coin)

@spec mid_px(t() | map(), String.t()) :: {:ok, String.t()} | {:error, :not_found}

Mid price for a coin.

Returns {:error, :not_found} when the coin has no mid price, which includes the case where the API sent an explicit null.

Parameters

event: The subscription event
coin: Coin name

Returns

{:ok, String.t()} if present
{:error, :not_found} otherwise

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_fields()

Returns the configured postgres fields for partial storage, or nil for all fields.

postgres_table()

Returns the postgres table name if configured (primary table for legacy support).

storage_enabled?()

Returns true if any storage backend is enabled.