View Source Hyperliquid.Api.Info.SettledOutcome (hyperliquid v0.3.1)

Settlement information for a HIP-4 prediction market outcome.

Returns nil when the outcome exists but has not settled yet.

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

Usage

{:ok, settled} = SettledOutcome.request(7)
SettledOutcome.settled?(settled)

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

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for settled outcome data.

fetch(outcome)

Fetch data and persist to configured storage backends.

fetch!(outcome)

Fetch data and persist. Raises on error.

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

Make the API request and parse the response.

request!(outcome)

Make the API request, raising on error.

request_raw(outcome)

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

request_raw!(outcome)

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

resolved_yes?(outcome)

Whether the outcome resolved fully to the YES side.

settle_fraction(settled_outcome)

Settlement fraction as a float.

settled?(arg1)

Whether the outcome has settled.

storage_enabled?()

Returns true if any storage backend is enabled.

Types

t()

@type t() :: %Hyperliquid.Api.Info.SettledOutcome{
  details: String.t() | nil,
  question: map() | nil,
  settle_fraction: String.t() | nil,
  spec: map() | nil
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.SettledOutcome.__endpoint_info__()
%{
  endpoint: "settledOutcome",
  type: :info,
  rate_limit_cost: 2,
  params: [:outcome],
  optional_params: [],
  doc: "Retrieve settlement information for an outcome",
  returns: "Settlement details, or null when the outcome has not settled"
}

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

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

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

Creates a changeset for settled outcome data.

Parameters

outcome: The settled outcome struct
attrs: Map of attributes

Returns

Ecto.Changeset.t()

fetch(outcome)

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

Fetch data and persist. Raises on error.

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

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

Make the API request and parse the response.

request!(outcome)

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

Make the API request, raising on error.

request_raw(outcome)

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

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

request_raw!(outcome)

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

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

resolved_yes?(outcome)

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

Whether the outcome resolved fully to the YES side.

Parameters

outcome: The settled outcome struct

Returns

boolean()

settle_fraction(settled_outcome)

@spec settle_fraction(t()) :: {:ok, float()} | {:error, :not_settled}

Settlement fraction as a float.

Parameters

outcome: The settled outcome struct

Returns

{:ok, float()} when settled
{:error, :not_settled} otherwise

settled?(arg1)

@spec settled?(t() | nil) :: boolean()

Whether the outcome has settled.

Parameters

outcome: The settled outcome struct

Returns

boolean()

storage_enabled?()

Returns true if any storage backend is enabled.