> ## 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.

# BreadthCounts Schema

> Auditable counts behind an aggregate Hyperliquid core perpetual or HIP-3 breadth snapshot. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.7.0; 218 paths; 210 component schemas.

Auditable counts behind an aggregate Hyperliquid core perpetual or HIP-3 breadth snapshot.

## Required Fields

| Field | Type | Description |
| - | - | - |
| `above` | integer:int32 | Eligible instruments trading above their current UTC-session VWAP. |
| `at` | integer:int32 | Eligible instruments at their current UTC-session VWAP. |
| `below` | integer:int32 | Eligible instruments trading below their current UTC-session VWAP. |
| `candidates` | integer:int32 | Cumulative candidate instruments considered at this calculation cutoff. |
| `eligible` | integer:int32 | Eligible instruments included in the headline percentage. |
| `excluded_no_session_volume` | integer:int32 | Candidates excluded because the current UTC session has no qualifying volume. |
| `excluded_stale_price` | integer:int32 | Candidates with session volume excluded because their most recent completed 1-minute candle close was older than the 5-minute freshness threshold at the calculation cutoff. |

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BreadthCounts",
  "description": "Auditable counts behind an aggregate Hyperliquid core perpetual or HIP-3 breadth snapshot.",
  "type": "object",
  "required": [
    "above",
    "at",
    "below",
    "candidates",
    "eligible",
    "excluded_no_session_volume",
    "excluded_stale_price"
  ],
  "properties": {
    "above": {
      "description": "Eligible instruments trading above their current UTC-session VWAP.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    },
    "at": {
      "description": "Eligible instruments at their current UTC-session VWAP.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    },
    "below": {
      "description": "Eligible instruments trading below their current UTC-session VWAP.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    },
    "candidates": {
      "description": "Cumulative candidate instruments considered at this calculation cutoff. This is not a fixed inventory, and candidate counts are not guaranteed to be monotonic across historical snapshots.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    },
    "eligible": {
      "description": "Eligible instruments included in the headline percentage.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    },
    "excluded_no_session_volume": {
      "description": "Candidates excluded because the current UTC session has no qualifying volume.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    },
    "excluded_stale_price": {
      "description": "Candidates with session volume excluded because their most recent completed 1-minute candle close was older than the 5-minute freshness threshold at the calculation cutoff. Candidates without session volume are counted only in excluded_no_session_volume.",
      "type": "integer",
      "format": "int32",
      "minimum": 0
    }
  }
}
```

## Referenced By

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.