Liquidation Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Liquidation",
  "description": "Liquidation event",
  "type": "object",
  "required": [
    "coin",
    "liquidated_user",
    "liquidator_user",
    "price",
    "side",
    "size",
    "symbol",
    "timestamp"
  ],
  "properties": {
    "closed_pnl": {
      "description": "Realized PnL from the liquidation (usually negative)",
      "type": "string",
      "nullable": true,
      "example": "-1250.50"
    },
    "coin": {
      "description": "Trading pair symbol (deprecated, use symbol instead)",
      "type": "string",
      "deprecated": true,
      "example": "BTC"
    },
    "direction": {
      "description": "Upstream direction label (for example `Close Long`, `Close Short`; HIP-3 can also emit `Open Long`, `Open Short`, or rare unclassified values such as `Long > Short`)",
      "type": "string",
      "nullable": true,
      "example": "Close Long"
    },
    "liquidated_user": {
      "description": "Address of the user who was liquidated",
      "type": "string",
      "example": "0x84eec0068b37919cc8f13d7454073ac167374cc0"
    },
    "liquidator_user": {
      "description": "Address of the liquidator (counterparty)",
      "type": "string",
      "example": "0x4d969e59b312970cc07af266938a4433ccae0b4c"
    },
    "mark_price": {
      "description": "Mark price at time of liquidation",
      "type": "string",
      "nullable": true,
      "example": "42480.25"
    },
    "price": {
      "description": "Price at which the liquidation was executed",
      "type": "string",
      "example": "42500.50"
    },
    "side": {
      "description": "Exchange side code for the liquidation-related fill (`A`/`B`). Use `direction` for close/open interpretation, especially on HIP-3.",
      "type": "string",
      "example": "B"
    },
    "size": {
      "description": "Size of the liquidated position",
      "type": "string",
      "example": "1.5"
    },
    "symbol": {
      "description": "Trading pair symbol",
      "type": "string",
      "example": "BTC"
    },
    "timestamp": {
      "description": "Liquidation timestamp (UTC)",
      "type": "string",
      "format": "date-time",
      "example": "2025-05-21T10:30:00.000Z"
    },
    "trade_id": {
      "description": "Trade ID for this liquidation",
      "type": "integer",
      "format": "int64",
      "nullable": true,
      "example": 1234567890
    },
    "tx_hash": {
      "description": "Blockchain transaction hash",
      "type": "string",
      "nullable": true,
      "example": "0xe266d353038e679c5d7e042433054f0000e1d8e52f7860ecda84573b9b5a02ca"
    }
  }
}