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

User transaction history from the explorer.

Returns recent transactions for a user address.

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

Usage

{:ok, details} = UserDetails.request("0x1234...")
UserDetails.tx_count(details)

Summary

Types

t()

tx()

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(details \\ %__MODULE__{}, attrs)

Creates a changeset for user details data.

fetch(user)

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

fetch!(user)

latest_tx(arg1)

Get the most recent transaction.

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.

tx_count(arg1)

Get the number of transactions.

Types

t()

@type t() :: %Hyperliquid.Api.Explorer.UserDetails{txs: [tx()]}

tx()

@type tx() :: %{
  time: non_neg_integer(),
  user: String.t(),
  action: map(),
  grouping: String.t()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Explorer.UserDetails.__endpoint_info__()
%{
  endpoint: "userDetails",
  type: :explorer,
  rate_limit_cost: 2,
  params: [:user],
  optional_params: [],
  doc: "Retrieve user transaction history",
  returns: "List of recent transactions for the user"
}

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

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for user details data.

fetch(user)

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

fetch!(user)

latest_tx(arg1)

@spec latest_tx(t()) :: {:ok, tx()} | {:error, :no_transactions}

Get the most recent transaction.

parse_response(data)

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

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

@spec rate_limit_cost() :: non_neg_integer()

Get the rate limit cost for this endpoint.

request(user)

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

Make the API request and parse the response.

request!(user)

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

Make the API request, raising on error.

request_raw(user)

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

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

request_raw!(user)

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

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

storage_enabled?()

Returns true if any storage backend is enabled.

tx_count(arg1)

@spec tx_count(t()) :: non_neg_integer()

Get the number of transactions.