Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.CandleSnapshot.__endpoint_info__()
%{
  endpoint: "candleSnapshot",
  type: :info,
  rate_limit_cost: 2,
  params: [:coin, :interval, :start_time, :end_time],
  optional_params: [],
  doc: "Retrieve OHLCV candle data for a coin",
  returns: "Array of candles with OHLCV data and trade counts"
}

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(term(), term(), term(), term()) :: 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 candle snapshot data.

Parameters

• snapshot: The snapshot struct
• attrs: Map with candles key

Returns

• Ecto.Changeset.t()

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 data and persist. Raises on error.

@spec in_range(t(), non_neg_integer(), non_neg_integer()) :: [map()]

Get candles within a time range.

Parameters

• snapshot: The candle snapshot struct
• start_time: Start timestamp in ms
• end_time: End timestamp in ms

Returns

• List of candles within range

@spec latest(t()) :: {:ok, map()} | {:error, :empty}

Get the latest candle.

Parameters

• snapshot: The candle snapshot struct

Returns

• {:ok, Candle.t()} if candles exist
• {:error, :empty} if no candles

@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(term(), term(), term(), term()) :: {:ok, t()} | {:error, term()}

Make the API request and parse the response.

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

Make the API request, raising on error.

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

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

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

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

Returns true if any storage backend is enabled.

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

Get valid candle intervals.

Returns

• List of valid interval strings

@spec vwap(t()) :: {:ok, float()} | {:error, :empty}

Calculate VWAP (Volume Weighted Average Price) for the snapshot.

Parameters

• snapshot: The candle snapshot struct

Returns

• {:ok, float()} - VWAP value
• {:error, :empty} - No candles