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

Margin table details.

Returns margin requirements and leverage tiers.

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

Usage

{:ok, table} = MarginTable.request(0)
max_lev = MarginTable.max_leverage_for_size(table, 100000.0)

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for margin table data.

fetch(id)

Fetch data and persist to configured storage backends.

fetch!(id)

Fetch data and persist. Raises on error.

max_leverage_for_size(margin_table, size)

Get max leverage for a position 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(id)

Make the API request and parse the response.

request!(id)

Make the API request, raising on error.

request_raw(id)

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

request_raw!(id)

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.MarginTable{
  description: String.t(),
  id: integer() | nil,
  margin_tiers: [MarginTier.t()]
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.MarginTable.__endpoint_info__()
%{
  endpoint: "marginTable",
  type: :info,
  rate_limit_cost: 1,
  params: [:id],
  optional_params: [],
  doc: "Retrieve margin table details",
  returns: "Margin requirements and leverage tiers"
}

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

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

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

Creates a changeset for margin table data.

fetch(id)

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

Fetch data and persist. Raises on error.

max_leverage_for_size(margin_table, size)

@spec max_leverage_for_size(t(), float()) :: integer()

Get max leverage for a position size.

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

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

Make the API request and parse the response.

request!(id)

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

Make the API request, raising on error.

request_raw(id)

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

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

request_raw!(id)

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