Trade Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Trade",
  "description": "Trade/fill record with full execution details",
  "type": "object",
  "required": [
    "coin",
    "price",
    "side",
    "size",
    "symbol",
    "timestamp"
  ],
  "properties": {
    "builder_address": {
      "description": "Builder address that routed this order. Present only when the order was placed through a builder.",
      "type": "string",
      "nullable": true
    },
    "builder_fee": {
      "description": "Builder fee charged on this fill, paid to the builder (in quote currency, typically USDC). Present only when builder_address is set.",
      "type": "string",
      "nullable": true
    },
    "cloid": {
      "description": "Client order ID",
      "type": "string",
      "nullable": true
    },
    "closed_pnl": {
      "description": "Realized PnL if closing a position",
      "type": "string",
      "nullable": true
    },
    "coin": {
      "description": "Trading pair symbol (deprecated, use symbol instead)",
      "type": "string",
      "deprecated": true,
      "example": "BTC"
    },
    "crossed": {
      "description": "True if taker (crossed the spread), false if maker",
      "type": "boolean",
      "nullable": true
    },
    "deployer_fee": {
      "description": "HIP-3 deployer fee share on this fill (in quote currency). Negative for the maker side (rebate), positive for the taker side. Present only on HIP-3 fills.",
      "type": "string",
      "nullable": true
    },
    "direction": {
      "description": "Position direction (e.g., 'Open Long', 'Close Short', 'Long > Short')",
      "type": "string",
      "nullable": true
    },
    "fee": {
      "description": "Trading fee amount",
      "type": "string",
      "nullable": true
    },
    "fee_token": {
      "description": "Fee denomination (e.g., USDC)",
      "type": "string",
      "nullable": true
    },
    "maker_address": {
      "description": "Maker's wallet address (the resting order)",
      "type": "string",
      "nullable": true
    },
    "order_id": {
      "description": "Associated order ID",
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "price": {
      "description": "Execution price",
      "type": "string",
      "example": "42150.50"
    },
    "priority_gas": {
      "description": "Priority fee burned in HYPE (not USDC) for write priority on the Hyperliquid validator queue. Independent of builder_fee and deployer_fee — paid to the network, not to a builder or deployer. Present only when the order paid for priority.",
      "type": "number",
      "nullable": true
    },
    "side": {
      "description": "Trade side: 'B' (buy) or 'A' (sell/ask)",
      "type": "string",
      "enum": [
        "A",
        "B"
      ],
      "example": "B"
    },
    "size": {
      "description": "Trade size",
      "type": "string",
      "example": "0.5"
    },
    "start_position": {
      "description": "Position size before this trade",
      "type": "string",
      "nullable": true
    },
    "symbol": {
      "description": "Trading pair symbol",
      "type": "string",
      "example": "BTC"
    },
    "taker_address": {
      "description": "Taker's wallet address (crossed the spread)",
      "type": "string",
      "nullable": true
    },
    "timestamp": {
      "description": "Execution timestamp (UTC)",
      "type": "string",
      "format": "date-time",
      "example": "2025-01-21T10:30:45.123Z"
    },
    "trade_id": {
      "description": "Unique trade ID",
      "type": "integer",
      "format": "int64",
      "nullable": true
    },
    "twap_id": {
      "description": "TWAP execution ID",
      "type": "integer",
      "nullable": true
    },
    "tx_hash": {
      "description": "Blockchain transaction hash",
      "type": "string",
      "nullable": true
    },
    "user_address": {
      "description": "User's wallet address",
      "type": "string",
      "nullable": true
    }
  }
}