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

Convenience functions for Stats API endpoints.

This module provides snake_case wrapper functions that delegate to the underlying endpoint modules, improving developer ergonomics.

Usage

# Direct endpoint call (still supported)
{:ok, result} = Hyperliquid.Api.Stats.Leaderboard.request()

# Convenience wrapper
{:ok, result} = Hyperliquid.Api.Stats.leaderboard()

See Hyperliquid.Api.Registry.list_by_type(:stats) for all available endpoints.

Summary

Functions

fetch_leaderboard()

Retrieve trading leaderboard

fetch_leaderboard!()

Retrieve trading leaderboard (fetch bang variant)

fetch_vaults()

Retrieve vault performance data

fetch_vaults!()

Retrieve vault performance data (fetch bang variant)

leaderboard()

Retrieve trading leaderboard

leaderboard!()

Retrieve trading leaderboard (bang variant)

vaults()

Retrieve vault performance data

vaults!()

Retrieve vault performance data (bang variant)

Functions

fetch_leaderboard()

@spec fetch_leaderboard() :: {:ok, struct()} | {:error, term()}

Retrieve trading leaderboard

Fetches data and persists to configured storage backends.

Delegates to Hyperliquid.Api.Stats.Leaderboard.fetch/0.

fetch_leaderboard!()

@spec fetch_leaderboard!() :: struct()

Retrieve trading leaderboard (fetch bang variant)

Fetches data, persists to storage, and raises on error.

Delegates to Hyperliquid.Api.Stats.Leaderboard.fetch!/0.

fetch_vaults()

@spec fetch_vaults() :: {:ok, struct()} | {:error, term()}

Retrieve vault performance data

Fetches data and persists to configured storage backends.

Delegates to Hyperliquid.Api.Stats.Vaults.fetch/0.

fetch_vaults!()

@spec fetch_vaults!() :: struct()

Retrieve vault performance data (fetch bang variant)

Fetches data, persists to storage, and raises on error.

Delegates to Hyperliquid.Api.Stats.Vaults.fetch!/0.

leaderboard()

@spec leaderboard() :: {:ok, struct()} | {:error, term()}

Retrieve trading leaderboard

Delegates to Hyperliquid.Api.Stats.Leaderboard.request/0.

Returns

Leaderboard with trader rankings and performance metrics

Examples

{:ok, result} = leaderboard()

leaderboard!()

@spec leaderboard!() :: struct()

Retrieve trading leaderboard (bang variant)

Delegates to Hyperliquid.Api.Stats.Leaderboard.request!/0.

Raises on error.

vaults()

@spec vaults() :: {:ok, struct()} | {:error, term()}

Retrieve vault performance data

Delegates to Hyperliquid.Api.Stats.Vaults.request/0.

Returns

List of vaults with APR, PnL, and summary information

Examples

{:ok, result} = vaults()

vaults!()

@spec vaults!() :: struct()

Retrieve vault performance data (bang variant)

Delegates to Hyperliquid.Api.Stats.Vaults.request!/0.

Raises on error.