View Source Hyperliquid.Api.Info.MetaAndAssetCtxs (hyperliquid v0.2.2)

Metadata and context for perpetual assets.

This endpoint returns a tuple of [Meta, AssetCtxs[]] in the TypeScript SDK, represented here as a schema with two fields: meta and asset_ctxs.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint/perpetuals#retrieve-perpetuals-asset-contexts-includes-mark-price-current-funding-open-interest-etc

Summary

Types

t()

Functions

__endpoint_info__()

Returns metadata about this endpoint.

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

build_cache_key(data)

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

build_request()

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

changeset(meta_and_asset_ctxs \\ %__MODULE__{}, attrs)

Creates a changeset for meta and asset contexts data.

fetch()

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

fetch!()

parse_response(data)

Parse and validate the API response.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_table()

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

postgres_upsert_config()

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

rate_limit_cost()

Get the rate limit cost for this endpoint.

request()

Make the API request and parse the response.

request!()

Make the API request, raising on error.

request_raw()

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

request_raw!()

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

storage_enabled?()

Returns true if any storage backend is enabled.

Types

t()

@type t() :: %Hyperliquid.Api.Info.MetaAndAssetCtxs{
  asset_ctxs: [AssetCtx.t()],
  meta: Meta.t()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.MetaAndAssetCtxs.__endpoint_info__()
%{
  endpoint: "metaAndAssetCtxs",
  type: :info,
  rate_limit_cost: 2,
  params: [],
  optional_params: [],
  doc: "Retrieve perpetuals metadata and asset contexts",
  returns: "Metadata and context for all perpetual assets"
}

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

build_cache_key(data)

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

build_request()

@spec build_request() :: map()

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

changeset(meta_and_asset_ctxs \\ %MODULE{}, attrs)

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

Creates a changeset for meta and asset contexts data.

Parameters

meta_and_asset_ctxs: The meta and asset contexts struct
attrs: Map of attributes to validate

Returns

Ecto.Changeset.t()

fetch()

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

fetch!()

parse_response(data)

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

Parse and validate the API response.

postgres_enabled?()

Returns true if postgres storage is enabled.

postgres_table()

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

postgres_upsert_config()

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

rate_limit_cost()

@spec rate_limit_cost() :: non_neg_integer()

Get the rate limit cost for this endpoint.

request()

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

Make the API request and parse the response.

request!()

@spec request!() :: t()

Make the API request, raising on error.

request_raw()

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

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

request_raw!()

@spec request_raw!() :: map()

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

storage_enabled?()

Returns true if any storage backend is enabled.