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

@type t() :: %Hyperliquid.Api.Info.PerpDexLimits{
  coin_to_oi_cap: [CoinOiCap.t()],
  max_transfer_ntl: String.t(),
  oi_sz_cap_per_perp: String.t(),
  total_oi_cap: String.t()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.PerpDexLimits.__endpoint_info__()
%{
  endpoint: "perpDexLimits",
  type: :info,
  rate_limit_cost: 1,
  params: [:dex],
  optional_params: [],
  doc: "Retrieve perpetual DEX limits",
  returns: "Caps and limits configured for a specific DEX"
}

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

@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(limits \\ %MODULE{}, attrs)

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

Creates a changeset for perp dex limits data.

Parameters

limits: The limits struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

coins_with_caps(perp_dex_limits)

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

Get all coins with specific OI caps.

Parameters

limits: The limits struct

Returns

List of coin symbols

fetch(dex)

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

fetch!(dex)

get_coin_oi_cap(perp_dex_limits, coin)

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

Get the OI cap for a specific coin.

Parameters

limits: The limits struct
coin: Coin symbol

Returns

{:ok, String.t()} if found
{:error, :not_found} if 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(term()) :: {:ok, t()} | {:error, term()}

Make the API request and parse the response.

request!(dex)

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

Make the API request, raising on error.

request_raw(dex)

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

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

request_raw!(dex)

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