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

Active trading data for a specific asset and user.

Returns leverage, max trade sizes, available balance, and mark price for a specific coin and user combination.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals

Usage

{:ok, data} = ActiveAssetData.request("0x1234...", "BTC")
ActiveAssetData.cross_margin?(data)

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(user, coin)

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for active asset data.

cross_margin?(active_asset_data)

Check if using cross margin.

fetch(user, coin)

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

fetch!(user, coin)

isolated_margin?(active_asset_data)

Check if using isolated margin.

leverage_value(active_asset_data)

Get the leverage value.

max_buy_size(arg1)

Get the max buy size.

max_sell_size(arg1)

Get the max sell size.

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, coin)

Make the API request and parse the response.

request!(user, coin)

Make the API request, raising on error.

request_raw(user, coin)

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

request_raw!(user, coin)

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

storage_enabled?()

Returns true if any storage backend is enabled.

Types

t()

@type t() :: %Hyperliquid.Api.Info.ActiveAssetData{
  available_to_trade: [String.t()],
  leverage: Leverage.t(),
  mark_px: String.t(),
  max_trade_szs: [String.t()]
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.ActiveAssetData.__endpoint_info__()
%{
  endpoint: "activeAssetData",
  type: :info,
  rate_limit_cost: 2,
  params: [:user, :coin],
  optional_params: [],
  doc: "Retrieve active trading data for a specific asset and user",
  returns: "Leverage, max trade sizes, available balance, and mark price"
}

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

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for active asset data.

Parameters

data: The active asset data struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

cross_margin?(active_asset_data)

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

Check if using cross margin.

Parameters

data: The active asset data struct

Returns

boolean()

fetch(user, coin)

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

fetch!(user, coin)

isolated_margin?(active_asset_data)

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

Check if using isolated margin.

Parameters

data: The active asset data struct

Returns

boolean()

leverage_value(active_asset_data)

@spec leverage_value(t()) :: integer()

Get the leverage value.

Parameters

data: The active asset data struct

Returns

Integer leverage value

max_buy_size(arg1)

@spec max_buy_size(t()) :: {:ok, String.t()} | {:error, :not_available}

Get the max buy size.

Parameters

data: The active asset data struct

Returns

{:ok, String.t()} if available
{:error, :not_available} if not available

max_sell_size(arg1)

@spec max_sell_size(t()) :: {:ok, String.t()} | {:error, :not_available}

Get the max sell size.

Parameters

data: The active asset data struct

Returns

{:ok, String.t()} if available
{:error, :not_available} if not available

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, coin)

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

Make the API request and parse the response.

request!(user, coin)

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

Make the API request, raising on error.

request_raw(user, coin)

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

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

request_raw!(user, coin)

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

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

storage_enabled?()

Returns true if any storage backend is enabled.