Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.PredictedFundings.__endpoint_info__()
%{
  endpoint: "predictedFundings",
  type: :info,
  rate_limit_cost: 2,
  params: [],
  optional_params: [],
  doc: "Retrieve predicted funding rates for perpetuals",
  returns: "Funding rate predictions across different venues"
}

Returns postgres table configurations (multi-table support).

Returns storage configuration for this endpoint.

Build a cache key from response data using the configured pattern. Returns nil if cache is not enabled or no pattern configured.

@spec build_request() :: map()

Build the request payload.

Returns true if cache storage is enabled.

Returns the cache TTL if configured.

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

Creates a changeset for predicted fundings data.

Parameters

• predictions: The predictions struct
• attrs: Nested array from API response

Returns

• Ecto.Changeset.t()

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

Get all coins with predictions.

Parameters

• predicted_fundings: The predicted fundings struct

Returns

• List of coin symbols

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

@spec get_coin(t(), String.t()) :: {:ok, [map()]} | {:error, :not_found}

Get funding predictions for a specific coin.

Parameters

• predicted_fundings: The predicted fundings struct
• coin: Coin symbol

Returns

• {:ok, [VenuePrediction.t()]} if found
• {:error, :not_found} if not found

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

Get the funding rate for a specific coin and venue.

Parameters

• predicted_fundings: The predicted fundings struct
• coin: Coin symbol
• venue: Venue name

Returns

• {:ok, String.t()} if found
• {:error, :not_found} if not found

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

Parse and validate the API response.

Returns true if postgres storage is enabled.

Returns the postgres table name if configured (primary table for legacy support).

Returns the upsert config for postgres (primary table for legacy support).

@spec rate_limit_cost() :: non_neg_integer()

Get the rate limit cost for this endpoint.

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

Make the API request and parse the response.

@spec request!() :: t()

Make the API request, raising on error.

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

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

@spec request_raw!() :: map()

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

Returns true if any storage backend is enabled.