View Source Hyperliquid.Api.Info.TokenDetails (hyperliquid v0.2.2)

@type t() :: %Hyperliquid.Api.Info.TokenDetails{
  circulating_supply: String.t(),
  deploy_gas: String.t() | nil,
  deploy_time: String.t() | nil,
  deployer: String.t() | nil,
  future_emissions: String.t(),
  genesis: map() | nil,
  mark_px: String.t(),
  max_supply: String.t(),
  mid_px: String.t(),
  name: String.t(),
  non_circulating_user_balances: list(),
  prev_day_px: String.t(),
  seeded_usdc: String.t(),
  sz_decimals: non_neg_integer(),
  token_id: String.t() | nil,
  total_supply: String.t(),
  wei_decimals: non_neg_integer()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.TokenDetails.__endpoint_info__()
%{
  endpoint: "tokenDetails",
  type: :info,
  rate_limit_cost: 1,
  params: [:tokenId],
  optional_params: [],
  doc: "Retrieve token details",
  returns: "Detailed information about a specific token"
}

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

@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 token details data.

fetch(tokenId)

Fetch data and persist to configured storage backends.

This calls request/N and then stores the result using Storage.Writer. Request params are merged into stored data for cache key generation.

fetch!(tokenId)

Fetch data and persist. Raises on error.

has_genesis?(token_details)

@spec has_genesis?(t()) :: boolean()

Check if token has genesis data.

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

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

Make the API request and parse the response.

request!(tokenId)

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

Make the API request, raising on error.

request_raw(tokenId)

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

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

request_raw!(tokenId)

@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.