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

L2 order book snapshot for a coin.

Returns bid and ask levels with prices and sizes.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-order-book

Usage

{:ok, book} = L2Book.request("BTC")
{:ok, mid} = L2Book.mid_price(book)
# => {:ok, 50000.5}

# Or with bang variant
book = L2Book.request!("BTC")

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.

best_ask(arg1)

Get best ask price.

best_bid(arg1)

Get best bid price.

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(coin)

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for L2 book data.

fetch(coin)

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

fetch!(coin)

mid_price(book)

Get mid price.

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(coin)

Make the API request and parse the response.

request!(coin)

Make the API request, raising on error.

request_raw(coin)

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

request_raw!(coin)

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

spread(book)

Get spread.

storage_enabled?()

Returns true if any storage backend is enabled.

Types

t()

@type t() :: %Hyperliquid.Api.Info.L2Book{
  coin: String.t(),
  levels: [Level.t()],
  time: non_neg_integer()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.L2Book.__endpoint_info__()
%{
  endpoint: "l2Book",
  type: :info,
  rate_limit_cost: 2,
  params: [:coin],
  optional_params: [],
  doc: "Retrieve L2 order book snapshot for a coin",
  returns: "Order book with bids/asks arrays containing price, size, and order count"
}

__postgres_tables__()

Returns postgres table configurations (multi-table support).

__storage_config__()

Returns storage configuration for this endpoint.

best_ask(arg1)

@spec best_ask(t()) :: {:ok, String.t()} | {:error, :empty}

Get best ask price.

best_bid(arg1)

@spec best_bid(t()) :: {:ok, String.t()} | {:error, :empty}

Get best bid price.

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(coin)

@spec build_request(term()) :: map()

Build the request payload.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for L2 book data.

fetch(coin)

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

fetch!(coin)

mid_price(book)

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

Get mid price.

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(coin)

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

Make the API request and parse the response.

request!(coin)

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

Make the API request, raising on error.

request_raw(coin)

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

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

request_raw!(coin)

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

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

spread(book)

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

Get spread.

storage_enabled?()

Returns true if any storage backend is enabled.