Get HIP-3 aggregated liquidation volume JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationVolume path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-3 trading pair symbol (e.g., hyna:BTC, km:US500). Case-sensitive.",
      "type": "string",
      "example": "hyna:BTC",
      "x-parameter-location": "path"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationVolume query parameters",
  "type": "object",
  "required": [
    "start"
  ],
  "properties": {
    "start": {
      "description": "Start timestamp (Unix milliseconds)",
      "type": "integer",
      "format": "int64",
      "example": 1769922000000,
      "x-parameter-location": "query"
    },
    "end": {
      "description": "End timestamp (Unix milliseconds). Defaults to now.",
      "type": "integer",
      "format": "int64",
      "x-parameter-location": "query"
    },
    "cursor": {
      "description": "Pagination cursor (timestamp in milliseconds)",
      "type": "string",
      "x-parameter-location": "query"
    },
    "limit": {
      "description": "Maximum buckets to return (1-1000)",
      "type": "integer",
      "default": 1000,
      "maximum": 1000,
      "x-parameter-location": "query"
    },
    "interval": {
      "description": "Aggregation interval",
      "type": "string",
      "enum": [
        "5m",
        "15m",
        "30m",
        "1h",
        "4h",
        "1d"
      ],
      "default": "1h",
      "x-parameter-location": "query"
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationVolume response 200",
  "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
    }
  }
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationVolume response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationVolume response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3LiquidationVolume response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

{
  "code": 429,
  "error": "Rate limit exceeded"
}