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

Mapping of coin symbols to mid prices.

This endpoint returns a dynamic map where keys are coin symbols (e.g., "BTC", "ETH") and values are mid prices as strings.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-mids-for-all-coins

Usage

{:ok, all_mids} = AllMids.request()
{:ok, price} = AllMids.get_mid(all_mids, "BTC")
# => {:ok, "43250.5"}

# Or with bang variant
all_mids = AllMids.request!()

Summary

Types

t()

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(opts \\ [])

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for all mids data.

fetch(opts \\ [])

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

fetch!(opts \\ [])

get_coins(all_mids)

Get all coin symbols.

get_mid(all_mids, coin)

Get the mid price for a specific coin.

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

Make the API request and parse the response.

request!(dex)

Make the API request, raising on error.

request_raw(opts \\ [])

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

request_raw!(opts \\ [])

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

storage_enabled?()

Returns true if any storage backend is enabled.

to_list(all_mids)

Convert the mids map to a list of {coin, price} tuples.

Types

t()

@type t() :: %Hyperliquid.Api.Info.AllMids{
  dex: String.t() | nil,
  mids: %{required(String.t()) => String.t()}
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.AllMids.__endpoint_info__()
%{
  endpoint: "allMids",
  type: :info,
  rate_limit_cost: 2,
  params: [],
  optional_params: [:dex],
  doc: "Retrieve mid prices for all actively traded coins",
  returns: "Map of coin symbols to mid prices as strings"
}

__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(opts \\ [])

@spec build_request(keyword()) :: map()

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for all mids data.

Parameters

all_mids: The all mids struct
attrs: Map of coin symbols to mid prices

fetch(opts \\ [])

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

fetch!(opts \\ [])

get_coins(all_mids)

@spec get_coins(t()) :: [String.t()]

Get all coin symbols.

Example

iex> get_coins(%AllMids{mids: %{"BTC" => "43250.5", "ETH" => "2280.75"}})
["BTC", "ETH"]

get_mid(all_mids, coin)

@spec get_mid(t(), String.t()) :: {:ok, String.t()} | {:error, :not_found}

Get the mid price for a specific coin.

Example

iex> get_mid(%AllMids{mids: %{"BTC" => "43250.5"}}, "BTC")
{:ok, "43250.5"}

iex> get_mid(%AllMids{mids: %{"BTC" => "43250.5"}}, "DOGE")
{:error, :not_found}

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

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

Make the API request and parse the response.

request!(dex)

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

Make the API request, raising on error.

request_raw(opts \\ [])

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

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

request_raw!(opts \\ [])

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

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

storage_enabled?()

Returns true if any storage backend is enabled.

to_list(all_mids)

@spec to_list(t()) :: [{String.t(), String.t()}]

Convert the mids map to a list of {coin, price} tuples.

Example

iex> to_list(%AllMids{mids: %{"BTC" => "43250.5", "ETH" => "2280.75"}})
[{"BTC", "43250.5"}, {"ETH", "2280.75"}]