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

Open orders with frontend display information.

Similar to openOrders but includes additional display fields used by the frontend.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#retrieve-a-users-open-orders-with-additional-frontend-info

Usage

{:ok, orders} = FrontendOpenOrders.request("0x1234...")
buys = FrontendOpenOrders.buys(orders)

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

Build the request payload.

buys(frontend_open_orders)

Get buy orders.

by_coin(frontend_open_orders, coin)

Get orders for a specific coin.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

Creates a changeset for frontend open orders data.

count(frontend_open_orders)

Get total order count.

fetch(user)

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

fetch!(user)

find_by_oid(frontend_open_orders, oid)

Find order by OID.

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.

reduce_only_orders(frontend_open_orders)

Get reduce-only orders.

request(user)

Make the API request and parse the response.

request!(user)

Make the API request, raising on error.

request_raw(user)

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

request_raw!(user)

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

sells(frontend_open_orders)

Get sell orders.

storage_enabled?()

Returns true if any storage backend is enabled.

trigger_orders(frontend_open_orders)

Get trigger orders only.

Types

t()

@type t() :: %Hyperliquid.Api.Info.FrontendOpenOrders{orders: [Order.t()]}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.FrontendOpenOrders.__endpoint_info__()
%{
  endpoint: "frontendOpenOrders",
  type: :info,
  rate_limit_cost: 2,
  params: [:user],
  optional_params: [],
  doc: "Retrieve open orders with frontend display information",
  returns: "List of open orders with additional display fields"
}

__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(user)

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

Build the request payload.

buys(frontend_open_orders)

@spec buys(t()) :: [map()]

Get buy orders.

Parameters

orders: The frontend open orders struct

Returns

List of buy orders

by_coin(frontend_open_orders, coin)

@spec by_coin(t(), String.t()) :: [map()]

Get orders for a specific coin.

Parameters

orders: The frontend open orders struct
coin: Coin symbol

Returns

List of orders for the coin

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

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

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

Creates a changeset for frontend open orders data.

Parameters

orders: The frontend open orders struct
attrs: Map with orders key

Returns

Ecto.Changeset.t()

count(frontend_open_orders)

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

Get total order count.

Parameters

orders: The frontend open orders struct

Returns

non_neg_integer()

fetch(user)

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

fetch!(user)

find_by_oid(frontend_open_orders, oid)

@spec find_by_oid(t(), integer()) :: {:ok, map()} | {:error, :not_found}

Find order by OID.

Parameters

orders: The frontend open orders struct
oid: Order ID

Returns

{:ok, Order.t()} if found
{:error, :not_found} if not found

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.

reduce_only_orders(frontend_open_orders)

@spec reduce_only_orders(t()) :: [map()]

Get reduce-only orders.

Parameters

orders: The frontend open orders struct

Returns

List of reduce-only orders

request(user)

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

Make the API request and parse the response.

request!(user)

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

Make the API request, raising on error.

request_raw(user)

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

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

request_raw!(user)

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

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

sells(frontend_open_orders)

@spec sells(t()) :: [map()]

Get sell orders.

Parameters

orders: The frontend open orders struct

Returns

List of sell orders

storage_enabled?()

Returns true if any storage backend is enabled.

trigger_orders(frontend_open_orders)

@spec trigger_orders(t()) :: [map()]

Get trigger orders only.

Parameters

orders: The frontend open orders struct

Returns

List of trigger orders