> ## Documentation Index
> Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
> Use this file to discover all available pages before exploring further.

# LiquidationVolume Schema

> Aggregated liquidation volume for a time bucket. Includes generated fields, route metadata, response shapes, and implementation-safe 0xArchive contract details.

Source OpenAPI: 0xArchive API 1.5.0; 140 paths; 119 component schemas.

Aggregated liquidation volume for a time bucket

## Required Fields

| Field         | Type             | Description                                          |
| ------------- | ---------------- | ---------------------------------------------------- |
| `coin`        | string           | Trading pair symbol (deprecated, use symbol instead) |
| `count`       | integer          | Total number of liquidations                         |
| `long_count`  | integer          | Number of long liquidations                          |
| `long_usd`    | number           | Long liquidation volume in USD                       |
| `short_count` | integer          | Number of short liquidations                         |
| `short_usd`   | number           | Short liquidation volume in USD                      |
| `symbol`      | string           | Trading pair symbol                                  |
| `timestamp`   | string:date-time | Bucket start timestamp (UTC)                         |
| `total_usd`   | number           | Total liquidation volume in USD                      |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LiquidationVolume",
  "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
    }
  }
}
```

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.
