View Source Hyperliquid.Api.Info.UserNonFundingLedgerUpdates (hyperliquid v0.2.2)
User's non-funding ledger updates.
Returns deposits, withdrawals, transfers, and other non-funding ledger entries.
See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint
Summary
Functions
Returns metadata about this endpoint.
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.
Build the request payload.
Build the request payload with optional end_time parameter.
Returns true if cache storage is enabled.
Returns the cache TTL if configured.
Fetch is an alias for request when no storage is configured.
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).
Get the rate limit cost for this endpoint.
Make the API request and parse the response.
Make the API request, raising on error.
Make the API request and return the raw response map (no key transformation).
Make the API request returning raw map, raising on error.
Fetches ledger updates with optional end_time parameter.
Returns true if any storage backend is enabled.
Types
@type t() :: %Hyperliquid.Api.Info.UserNonFundingLedgerUpdates{updates: [Update.t()]}
Functions
Returns metadata about this endpoint.
Example
iex> Hyperliquid.Api.Info.UserNonFundingLedgerUpdates.__endpoint_info__()
%{
endpoint: "userNonFundingLedgerUpdates",
type: :info,
rate_limit_cost: 1,
params: [:user, :start_time],
optional_params: [],
doc: "Retrieve user's non-funding ledger updates",
returns: "Deposits, withdrawals, transfers, and other non-funding ledger entries"
}
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.
Build the request payload.
@spec build_request_with_end_time(String.t(), non_neg_integer(), non_neg_integer()) :: map()
Build the request payload with optional end_time parameter.
Parameters
user: User address (0x...)start_time: Start timestamp in msend_time: Optional end timestamp in ms
Returns
- Map with request parameters
Returns true if cache storage is enabled.
Returns the cache TTL if configured.
@spec changeset(t(), map()) :: Ecto.Changeset.t()
@spec count(t()) :: non_neg_integer()
Fetch is an alias for request when no storage is configured.
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.
Make the API request and parse the response.
Make the API request, raising on error.
Make the API request and return the raw response map (no key transformation).
Make the API request returning raw map, raising on error.
@spec request_with_end_time(String.t(), non_neg_integer(), non_neg_integer() | nil) :: {:ok, t()} | {:error, term()}
Fetches ledger updates with optional end_time parameter.
Parameters
user: User address (0x...)start_time: Start timestamp in msend_time: Optional end timestamp in ms
Returns
{:ok, %UserNonFundingLedgerUpdates{}}- Parsed and validated data{:error, term()}- Error from HTTP or validation
Returns true if any storage backend is enabled.