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

@type t() :: %Hyperliquid.Api.Info.IsVip{
  is_vip: boolean(),
  maker_rate: String.t() | nil,
  taker_rate: String.t() | nil,
  vip_tier: non_neg_integer() | nil
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.IsVip.__endpoint_info__()
%{
  endpoint: "isVip",
  type: :info,
  rate_limit_cost: 1,
  params: [:user],
  optional_params: [],
  doc: "Check VIP status for a user",
  returns: "VIP status with tier and fee rates if applicable"
}

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

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

Creates a changeset for VIP status data.

Parameters

vip: The VIP status struct
attrs: Map or boolean value from API response

Returns

Ecto.Changeset.t()

fee_rates(arg1)

@spec fee_rates(t()) :: {:ok, map()} | {:error, :not_available}

Get fee rates if available.

Parameters

vip: The VIP status struct

Returns

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

fetch(user)

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

fetch!(user)

parse_response(data)

@spec parse_response(boolean() | nil | map()) :: {:ok, t()} | {:error, term()}

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

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

tier(is_vip)

@spec tier(t()) :: {:ok, non_neg_integer()} | {:error, :not_vip | :no_tier}

Get the VIP tier.

Parameters

vip: The VIP status struct

Returns

{:ok, non_neg_integer()} if VIP with tier
{:error, :not_vip} if not VIP
{:error, :no_tier} if VIP but no tier info

vip?(is_vip)

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

Check if user is a VIP.

Parameters

vip: The VIP status struct

Returns

boolean()