View Source Hyperliquid.Api.Info.PerpDexs (hyperliquid v0.2.2)
List of all perpetual DEXs.
Returns information about all deployed perpetual DEXs including their names, deployers, and streaming OI caps.
See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals
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.
Get DEXs deployed by a specific address.
Returns true if cache storage is enabled.
Returns the cache TTL if configured.
Creates a changeset for perp dexs data.
Fetch data and persist to configured storage backends.
Fetch data and persist. Raises on error.
Find a DEX by name.
Get all DEX names.
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.
Returns true if any storage backend is enabled.
Types
@type t() :: %Hyperliquid.Api.Info.PerpDexs{dexs: [Dex.t()]}
Functions
Returns metadata about this endpoint.
Example
iex> Hyperliquid.Api.Info.PerpDexs.__endpoint_info__()
%{
endpoint: "perpDexs",
type: :info,
rate_limit_cost: 1,
params: [],
optional_params: [],
doc: "Retrieve all perpetual DEXs",
returns: "Information about all deployed perpetual DEXs"
}
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.
Get DEXs deployed by a specific address.
Parameters
perp_dexs: The perp dexs structdeployer: Deployer address
Returns
- List of DEXs deployed by the address
Returns true if cache storage is enabled.
Returns the cache TTL if configured.
@spec changeset(t(), map()) :: Ecto.Changeset.t()
Creates a changeset for perp dexs data.
Parameters
perp_dexs: The perp dexs structattrs: Map with dexs 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.
Find a DEX by name.
Parameters
perp_dexs: The perp dexs structname: DEX name to find
Returns
{:ok, Dex.t()}if found{:error, :not_found}if not found
Get all DEX names.
Parameters
perp_dexs: The perp dexs struct
Returns
- List of DEX names
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.
@spec request!() :: t()
Make the API request, raising on error.
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.