View Source Hyperliquid.Api.Info.WebData2 (hyperliquid v0.4.1)

One-shot REST snapshot of comprehensive user and market data.

Returns a full snapshot equivalent to the webData2 WebSocket subscription, including clearinghouse state, open orders, vault info, market metadata, TWAP states, and spot state for the given user.

The subscription-based version lives at Hyperliquid.Api.Subscription.WebData2. This module is the REST POST equivalent — useful for an initial load without subscribing to a stream.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint

Usage 

{:ok, snapshot} = WebData2.request("0x...")

Summary

Types

t()

Functions

__endpoint_info__()

Returns metadata about this endpoint.

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

build_cache_key(data)

Build a cache key from response data using the configured pattern. Returns nil if cache is not enabled or no pattern configured.

build_request(user)

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

changeset(state \\ %__MODULE__{}, attrs)
fetch(user)

Fetch is an alias for request when no storage is configured.

fetch!(user)
parse_response(data)

Parse and validate the API response.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_table()

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

postgres_upsert_config()

Returns the upsert config for postgres (primary table for legacy support).

rate_limit_cost()

Get the rate limit cost for this endpoint.

request(user)

Make the API request and parse the response.

request!(user)

Make the API request, raising on error.

request_raw(user)

Make the API request and return the raw response map (no key transformation).

request_raw!(user)

Make the API request returning raw map, raising on error.

storage_enabled?()

Returns true if any storage backend is enabled.

Types

Link to this type

t()

View Source 
@type t() :: %Hyperliquid.Api.Info.WebData2{data: map()}

Functions

Link to this function

__endpoint_info__()

View Source

Returns metadata about this endpoint.

Example 

iex> Hyperliquid.Api.Info.WebData2.__endpoint_info__()
%{
  endpoint: "webData2",
  type: :info,
  rate_limit_cost: 20,
  params: [:user],
  optional_params: [],
  doc: "Retrieve one-shot snapshot of comprehensive user and market data",
  returns: "Full webData2 snapshot including clearinghouse, orders, vaults, and market data"
}
Link to this function

__postgres_tables__()

View Source

Returns postgres table configurations (multi-table support).

Link to this function

__storage_config__()

View Source

Returns storage configuration for this endpoint.

Link to this function

build_cache_key(data)

View Source

Build a cache key from response data using the configured pattern. Returns nil if cache is not enabled or no pattern configured.

Link to this function

build_request(user)

View Source 
@spec build_request(term()) :: map()

Build the request payload.

Link to this function

cache_enabled?()

View Source

Returns true if cache storage is enabled.

Link to this function

cache_ttl()

View Source

Returns the cache TTL if configured.

Link to this function

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

View Source 
@spec changeset(t(), map()) :: Ecto.Changeset.t()
Link to this function

fetch(user)

View Source

Fetch is an alias for request when no storage is configured.

Link to this function

fetch!(user)

View Source
Link to this function

parse_response(data)

View Source 
@spec parse_response(map()) :: {:ok, t()} | {:error, term()}

Parse and validate the API response.

Link to this function

postgres_enabled?()

View Source

Returns true if postgres storage is enabled.

Link to this function

postgres_table()

View Source

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

Link to this function

postgres_upsert_config()

View Source

Returns the upsert config for postgres (primary table for legacy support).

Link to this function

rate_limit_cost()

View Source 
@spec rate_limit_cost() :: non_neg_integer()

Get the rate limit cost for this endpoint.

Link to this function

request(user)

View Source 
@spec request(term()) :: {:ok, t()} | {:error, term()}

Make the API request and parse the response.

Link to this function

request!(user)

View Source 
@spec request!(term()) :: t()

Make the API request, raising on error.

Link to this function

request_raw(user)

View Source 
@spec request_raw(term()) :: {:ok, map()} | {:error, term()}

Make the API request and return the raw response map (no key transformation).

Link to this function

request_raw!(user)

View Source 
@spec request_raw!(term()) :: map()

Make the API request returning raw map, raising on error.

Link to this function

storage_enabled?()

View Source

Returns true if any storage backend is enabled.