ApiResponseLiquidationVolumeArray Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseLiquidationVolumeArray",
  "description": "API response containing an array of aggregated liquidation volumes",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "description": "Aggregated liquidation volume for a time bucket",
        "type": "object",
        "required": [
          "coin",
          "count",
          "long_count",
          "long_usd",
          "short_count",
          "short_usd",
          "symbol",
          "timestamp",
          "total_usd"
        ],
        "properties": {
          "coin": {
            "description": "Trading pair symbol (deprecated, use symbol instead)",
            "type": "string",
            "deprecated": true,
            "example": "BTC"
          },
          "count": {
            "description": "Total number of liquidations",
            "type": "integer",
            "example": 42
          },
          "long_count": {
            "description": "Number of long liquidations",
            "type": "integer",
            "example": 25
          },
          "long_usd": {
            "description": "Long liquidation volume in USD",
            "type": "number",
            "example": 750000.25
          },
          "short_count": {
            "description": "Number of short liquidations",
            "type": "integer",
            "example": 17
          },
          "short_usd": {
            "description": "Short liquidation volume in USD",
            "type": "number",
            "example": 500000.25
          },
          "symbol": {
            "description": "Trading pair symbol",
            "type": "string",
            "example": "BTC"
          },
          "timestamp": {
            "description": "Bucket start timestamp (UTC)",
            "type": "string",
            "format": "date-time",
            "example": "2025-05-21T10:00:00.000Z"
          },
          "total_usd": {
            "description": "Total liquidation volume in USD",
            "type": "number",
            "example": 1250000.5
          }
        }
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "next_cursor": {
          "description": "Cursor for pagination",
          "type": "string",
          "nullable": true
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}