Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.ExtraAgents.__endpoint_info__()
%{
  endpoint: "extraAgents",
  type: :info,
  rate_limit_cost: 2,
  params: [:user],
  optional_params: [],
  doc: "Retrieve extra agents authorized by a user",
  returns: "List of additional agents with addresses, names, and validity periods"
}

Returns postgres table configurations (multi-table support).

Returns storage configuration for this endpoint.

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

Get all agent addresses.

Parameters

• agents: The extra agents struct

Returns

• List of agent addresses

@spec authorized?(t(), String.t()) :: boolean()

Check if an address is an authorized agent.

Parameters

• agents: The extra agents struct
• address: Address to check

Returns

• boolean()

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()) :: 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 extra agents data.

Parameters

• agents: The extra agents struct
• attrs: Map with agents key

Returns

• Ecto.Changeset.t()

@spec count(t()) :: non_neg_integer()

Get count of extra agents.

Parameters

• agents: The extra agents struct

Returns

• non_neg_integer()

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

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

Find agent by address.

Parameters

• agents: The extra agents struct
• address: Agent address

Returns

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

Make the API request and parse the response.

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

Make the API request, raising on error.

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

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

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

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

Returns true if any storage backend is enabled.

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

Get agents that are still valid.

Parameters

• agents: The extra agents struct
• current_time: Current time in milliseconds

Returns

• List of valid agents