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

User's rate limit status.

Returns current rate limit usage and limits.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-user-rate-limits

Usage

{:ok, limit} = UserRateLimit.request("0x...")
IO.puts("Used: #{UserRateLimit.usage_percent(limit)}%")

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)

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

fetch(user)

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

fetch!(user)

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.

remaining(user_rate_limit)

request(user)

Make the API request and parse the response.

request!(user)

Make the API request, raising on error.

request_raw(user)

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

request_raw!(user)

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

storage_enabled?()

Returns true if any storage backend is enabled.

usage_percent(arg1)

Types

t()

@type t() :: %Hyperliquid.Api.Info.UserRateLimit{
  cum_vlm: String.t(),
  n_requests_cap: non_neg_integer(),
  n_requests_surplus: non_neg_integer(),
  n_requests_used: non_neg_integer()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.UserRateLimit.__endpoint_info__()
%{
  endpoint: "userRateLimit",
  type: :info,
  rate_limit_cost: 20,
  params: [:user],
  optional_params: [],
  doc: "Query user rate limit status",
  returns: "UserRateLimit with usage and cap"
}

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

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

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

fetch(user)

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

fetch!(user)

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.

remaining(user_rate_limit)

@spec remaining(t()) :: non_neg_integer()

request(user)

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

Make the API request and parse the response.

request!(user)

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

Make the API request, raising on error.

request_raw(user)

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

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

request_raw!(user)

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

usage_percent(arg1)

@spec usage_percent(t()) :: float()