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

Convenience functions for Explorer 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.Explorer.BlockDetails.request(height: 12345)

# Convenience wrapper
{:ok, result} = Hyperliquid.Api.Explorer.block_details(12345)

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

Summary

Functions

block_details(height)

Retrieve block details by height

block_details!(height)

Retrieve block details by height (bang variant)

fetch_block_details(height)

Retrieve block details by height

fetch_block_details!(height)

Retrieve block details by height (fetch bang variant)

fetch_tx_details(hash)

Retrieve transaction details by hash

fetch_tx_details!(hash)

Retrieve transaction details by hash (fetch bang variant)

tx_details(hash)

Retrieve transaction details by hash

tx_details!(hash)

Retrieve transaction details by hash (bang variant)

user_details(user)

Retrieve user transaction history

user_details!(user)

Retrieve user transaction history (bang variant)

Functions

block_details(height)

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

Retrieve block details by height

Delegates to Hyperliquid.Api.Explorer.BlockDetails.request/1.

Parameters

height - Required parameter

Returns

Block with transactions, hash, and metadata

block_details!(height)

@spec block_details!(term()) :: struct()

Retrieve block details by height (bang variant)

Delegates to Hyperliquid.Api.Explorer.BlockDetails.request!/1.

Raises on error.

fetch_block_details(height)

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

Retrieve block details by height

Fetches data and persists to configured storage backends.

Delegates to Hyperliquid.Api.Explorer.BlockDetails.fetch/1.

fetch_block_details!(height)

@spec fetch_block_details!(term()) :: struct()

Retrieve block details by height (fetch bang variant)

Delegates to Hyperliquid.Api.Explorer.BlockDetails.fetch!/1.

fetch_tx_details(hash)

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

Retrieve transaction details by hash

Fetches data and persists to configured storage backends.

Delegates to Hyperliquid.Api.Explorer.TxDetails.fetch/1.

fetch_tx_details!(hash)

@spec fetch_tx_details!(term()) :: struct()

Retrieve transaction details by hash (fetch bang variant)

Delegates to Hyperliquid.Api.Explorer.TxDetails.fetch!/1.

tx_details(hash)

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

Retrieve transaction details by hash

Delegates to Hyperliquid.Api.Explorer.TxDetails.request/1.

Parameters

hash - Required parameter

Returns

Transaction details with block info and status

tx_details!(hash)

@spec tx_details!(term()) :: struct()

Retrieve transaction details by hash (bang variant)

Delegates to Hyperliquid.Api.Explorer.TxDetails.request!/1.

Raises on error.

user_details(user)

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

Retrieve user transaction history

Delegates to Hyperliquid.Api.Explorer.UserDetails.request/1.

Parameters

user - Required parameter

Returns

List of recent transactions for the user

user_details!(user)

@spec user_details!(term()) :: struct()

Retrieve user transaction history (bang variant)

Delegates to Hyperliquid.Api.Explorer.UserDetails.request!/1.

Raises on error.