View Source Hyperliquid.Api.Common (hyperliquid v0.2.2)

Common schemas used across multiple Hyperliquid API endpoints.

Auto-generated from @nktkas/hyperliquid v0.26.0 Source: src/api/_common_schemas.ts

This module contains Ecto embedded schemas for types that are reused across different API endpoints, including:

Balance (spot token balances)
DetailedOrder (open orders with frontend info)
TwapState (TWAP order state)
TIF (time-in-force enum)
OrderSchema (basic order details)

Summary

Types

balance()

Balance for a specific spot token.

detailed_order()

Open order with display information.

twap_state()

State of a TWAP order.

Functions

parse_balance(data)

Parse Balance data from API response.

parse_detailed_order(data)

Parse DetailedOrder data from API response.

parse_twap_state(data)

Parse TwapState data from API response.

Types

balance()

@type balance() :: %Hyperliquid.Api.Common.Balance{
  coin: term(),
  entry_ntl: term(),
  hold: term(),
  token: term(),
  total: term()
}

Balance for a specific spot token.

detailed_order()

@type detailed_order() :: %Hyperliquid.Api.Common.DetailedOrder{
  cloid: term(),
  coin: term(),
  is_position_tpsl: term(),
  is_trigger: term(),
  limit_px: term(),
  oid: term(),
  order_type: term(),
  orig_sz: term(),
  reduce_only: term(),
  side: term(),
  sz: term(),
  timestamp: term(),
  trigger_condition: term(),
  trigger_px: term()
}

Open order with display information.

twap_state()

@type twap_state() :: %Hyperliquid.Api.Common.TwapState{
  coin: term(),
  executed_ntl: term(),
  executed_sz: term(),
  minutes: term(),
  randomize: term(),
  reduce_only: term(),
  side: term(),
  sz: term(),
  timestamp: term(),
  user: term()
}

State of a TWAP order.

Functions

parse_balance(data)

Parse Balance data from API response.

parse_detailed_order(data)

Parse DetailedOrder data from API response.

parse_twap_state(data)

Parse TwapState data from API response.