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

Status of a specific order.

Returns detailed status information for an order by OID or CLOID.

See: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/info-endpoint#query-order-status-by-oid-or-cloid

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, oid)

Build the request payload.

build_request_by_cloid(user, cloid)

Build the request payload for orderStatus by CLOID.

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

canceled?(order_status)

Check if order is canceled.

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

Creates a changeset for order status data.

fetch(user, oid)

Fetch data and persist to configured storage backends.

fetch!(user, oid)

Fetch data and persist. Raises on error.

filled?(order_status)

Check if order is filled.

open?(order_status)

Check if order is open.

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

Make the API request and parse the response.

request!(user, oid)

Make the API request, raising on error.

request_by_cloid(user, cloid)

Fetches order status by CLOID from the API.

request_raw(user, oid)

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

request_raw!(user, oid)

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.OrderStatus{
  order: Order.t() | nil,
  status: String.t()
}

Functions

__endpoint_info__()

Returns metadata about this endpoint.

Example

iex> Hyperliquid.Api.Info.OrderStatus.__endpoint_info__()
%{
  endpoint: "orderStatus",
  type: :info,
  rate_limit_cost: 1,
  params: [:user, :oid],
  optional_params: [],
  doc: "Query order status by OID or CLOID",
  returns: "Detailed order status information"
}

__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, oid)

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

Build the request payload.

build_request_by_cloid(user, cloid)

@spec build_request_by_cloid(String.t(), String.t()) :: map()

Build the request payload for orderStatus by CLOID.

Parameters

user: User address (0x...)
cloid: Client order ID

cache_enabled?()

Returns true if cache storage is enabled.

cache_ttl()

Returns the cache TTL if configured.

canceled?(order_status)

@spec canceled?(t()) :: boolean()

Check if order is canceled.

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

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

Creates a changeset for order status data.

fetch(user, oid)

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!(user, oid)

Fetch data and persist. Raises on error.

filled?(order_status)

@spec filled?(t()) :: boolean()

Check if order is filled.

open?(order_status)

@spec open?(t()) :: boolean()

Check if order is open.

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

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

Make the API request and parse the response.

request!(user, oid)

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

Make the API request, raising on error.

request_by_cloid(user, cloid)

@spec request_by_cloid(String.t(), String.t()) :: {:ok, t()} | {:error, term()}

Fetches order status by CLOID from the API.

Parameters

user: User address (0x...)
cloid: Client order ID

Returns

{:ok, %OrderStatus{}} - Parsed and validated order status
{:error, term()} - Error from HTTP or validation

request_raw(user, oid)

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

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

request_raw!(user, oid)

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

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

storage_enabled?()

Returns true if any storage backend is enabled.