CCXT.Liquidation (ccxt_client v0.6.1)

Copy Markdown View Source

Unified liquidation event data.

Represents a liquidation event on a derivatives exchange.

Fields

  • symbol - Unified symbol (e.g., "BTC/USDT:USDT")
  • timestamp - Liquidation time in milliseconds
  • datetime - ISO 8601 datetime string
  • price - Liquidation price
  • base_value - Value in base currency
  • quote_value - Value in quote currency
  • contracts - Number of contracts liquidated
  • contract_size - Size of one contract
  • side - "long" or "short"
  • info - Raw exchange response

Summary

Functions

JSON Schema for the Liquidation unified type.

Types

t()

@type t() :: %CCXT.Liquidation{
  base_value: number() | nil,
  contract_size: number() | nil,
  contracts: number() | nil,
  datetime: String.t() | nil,
  info: map() | nil,
  price: number() | nil,
  quote_value: number() | nil,
  side: String.t() | nil,
  symbol: String.t() | nil,
  timestamp: integer() | nil
}

Functions

schema()

@spec schema() :: map()

JSON Schema for the Liquidation unified type.