View Source Hyperliquid.Api.Stats.Vaults (hyperliquid v0.2.2)

Vaults data from the Hyperliquid stats API.

Returns vault performance metrics, APR, PnL history, and summary information.

See: https://stats-data.hyperliquid.xyz/Mainnet/vaults

Usage 

{:ok, vaults} = Vaults.request()
{:ok, vault} = Vaults.get_vault(vaults, "0x...")

Summary

Types

t()
vault()
vault_relationship()
vault_summary()

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.

by_apr(arg1)

Get vaults sorted by APR (descending).

by_tvl(arg1)

Get vaults sorted by TVL (descending).

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for vaults data.

fetch()

Fetch data and persist to configured storage backends.

fetch!()

Fetch data and persist. Raises on error.

filter_by_status(arg1, is_closed)

Filter vaults by open/closed status.

get_vault(arg1, address)

Get a specific vault by address.

get_window_pnl(vault, window)

Get PnL for a specific time window from a vault.

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()

Make the API request and parse the response.

request!()

Make the API request, raising on error.

request_raw()

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

request_raw!()

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

storage_enabled?()

Returns true if any storage backend is enabled.

vault_count(arg1)

Get the number of vaults.

Types

Link to this type

t()

View Source 
@type t() :: %Hyperliquid.Api.Stats.Vaults{vaults: [vault()]}
Link to this type

vault()

View Source 
@type vault() :: %{
  apr: float(),
  pnls: [{String.t(), [String.t()]}],
  summary: vault_summary()
}
Link to this type

vault_relationship()

View Source 
@type vault_relationship() :: %{type: String.t()}
Link to this type

vault_summary()

View Source 
@type vault_summary() :: %{
  name: String.t(),
  vault_address: String.t(),
  leader: String.t(),
  tvl: String.t(),
  is_closed: boolean(),
  relationship: vault_relationship(),
  create_time_millis: non_neg_integer()
}

Functions

Link to this function

__endpoint_info__()

View Source

Returns metadata about this endpoint.

Example 

iex> Hyperliquid.Api.Stats.Vaults.__endpoint_info__()
%{
  endpoint: "vaults",
  type: :stats,
  rate_limit_cost: 0,
  params: [],
  optional_params: [],
  doc: "Retrieve vault performance data",
  returns: "List of vaults with APR, PnL, and summary information"
}
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

by_apr(arg1)

View Source 
@spec by_apr(t()) :: [vault()]

Get vaults sorted by APR (descending).

Parameters

  • vaults: The vaults struct

Returns

  • [vault()]
Link to this function

by_tvl(arg1)

View Source 
@spec by_tvl(t()) :: [vault()]

Get vaults sorted by TVL (descending).

Parameters

  • vaults: The vaults struct

Returns

  • [vault()]
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(vaults \\ %__MODULE__{}, attrs)

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

Creates a changeset for vaults data.

Link to this function

fetch()

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

Fetch data and persist to configured storage backends.

This calls request/0 and then stores the result using Storage.Writer.

Link to this function

fetch!()

View Source 
@spec fetch!() :: t()

Fetch data and persist. Raises on error.

Link to this function

filter_by_status(arg1, is_closed)

View Source 
@spec filter_by_status(t(), boolean()) :: [vault()]

Filter vaults by open/closed status.

Parameters

  • vaults: The vaults struct
  • is_closed: true for closed vaults, false for open vaults

Returns

  • [vault()]
Link to this function

get_vault(arg1, address)

View Source 
@spec get_vault(t(), String.t()) :: {:ok, vault()} | {:error, :not_found}

Get a specific vault by address.

Parameters

  • vaults: The vaults struct
  • address: Vault address (0x...)

Returns

  • {:ok, vault()} if found
  • {:error, :not_found} if not found
Link to this function

get_window_pnl(vault, window)

View Source 
@spec get_window_pnl(vault(), String.t()) ::
  {:ok, [String.t()]} | {:error, :not_found}

Get PnL for a specific time window from a vault.

Parameters

  • vault: A vault map
  • window: Time window ("day", "week", "month", "allTime")

Returns

  • {:ok, [String.t()]} if found (list of PnL values)
  • {:error, :not_found} if window not found
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()

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

Make the API request and parse the response.

Link to this function

request!()

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

Make the API request, raising on error.

Link to this function

request_raw()

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

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

Link to this function

request_raw!()

View Source 
@spec request_raw!() :: 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.

Link to this function

vault_count(arg1)

View Source 
@spec vault_count(t()) :: non_neg_integer()

Get the number of vaults.

Parameters

  • vaults: The vaults struct

Returns

  • non_neg_integer()