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

# ApiResponseMaBreadthReading Schema

> API response containing the newest moving-average breadth reading. Includes route metadata, schemas, examples, and implementation notes.

Source OpenAPI: 0xArchive API 1.13.0; 242 paths; 243 component schemas.

API response containing the newest moving-average breadth reading.

## Required Fields

No required fields are declared on this component schema.

## JSON Schema

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseMaBreadthReading",
  "description": "API response containing the newest moving-average breadth reading.",
  "type": "object",
  "properties": {
    "data": {
      "description": "One moving-average breadth reading: the last reading of a bucket.",
      "type": "object",
      "required": [
        "calculated_at",
        "calculated_at_ms",
        "counts",
        "coverage_ratio",
        "distance",
        "is_final",
        "method",
        "n",
        "timestamp",
        "timestamp_ms",
        "value_pct"
      ],
      "properties": {
        "calculated_at": {
          "description": "The reading's instant: the bucket's end, or for the bucket still forming the newest settled minute, about 4 minutes before now.",
          "type": "string",
          "format": "date-time",
          "example": "2026-10-21T00:00:00.000Z"
        },
        "calculated_at_ms": {
          "description": "`calculated_at` as Unix milliseconds.",
          "type": "integer",
          "format": "int64",
          "example": 1792540800000
        },
        "counts": {
          "description": "The counts a moving-average breadth reading is made from. `above + at + below = eligible`; `eligible + excluded_stale_price + excluded_short_history = candidates`.",
          "type": "object",
          "required": [
            "above",
            "at",
            "below",
            "candidates",
            "eligible",
            "excluded_short_history",
            "excluded_stale_price"
          ],
          "properties": {
            "above": {
              "description": "Eligible perps whose price is above their n-day moving average.",
              "type": "integer",
              "example": 61
            },
            "at": {
              "description": "Eligible perps whose price equals their n-day moving average.",
              "type": "integer",
              "example": 0
            },
            "below": {
              "description": "Eligible perps whose price is below their n-day moving average.",
              "type": "integer",
              "example": 116
            },
            "candidates": {
              "description": "Every perp the venue has listed, from its first one-minute candle on, delisted perps included.",
              "type": "integer",
              "example": 221
            },
            "eligible": {
              "description": "Candidates with a recent price and n days of history: the denominator of `value_pct`.",
              "type": "integer",
              "example": 177
            },
            "excluded_short_history": {
              "description": "Candidates younger than n UTC days before the reading's day.",
              "type": "integer",
              "example": 1
            },
            "excluded_stale_price": {
              "description": "Candidates with no one-minute close in the 24 hours before the reading. A delisted perp is counted here from 24 hours after its last trade.",
              "type": "integer",
              "example": 43
            }
          }
        },
        "coverage_ratio": {
          "description": "eligible / candidates, to 4 decimals. It depends on n and falls as perps delist: it is not a data-quality measure and is not comparable with breadth above session VWAP.",
          "type": "number",
          "format": "double",
          "minimum": 0,
          "maximum": 1,
          "example": 0.8009
        },
        "distance": {
          "description": "Quartiles of price / average - 1 over the eligible perps, to 6 decimals, linear interpolation. Each is null when nothing is eligible, never 0.",
          "type": "object",
          "required": [
            "median",
            "p25",
            "p75"
          ],
          "properties": {
            "median": {
              "type": "number",
              "format": "double",
              "nullable": true,
              "example": -0.027606
            },
            "p25": {
              "type": "number",
              "format": "double",
              "nullable": true,
              "example": -0.09803
            },
            "p75": {
              "type": "number",
              "format": "double",
              "nullable": true,
              "example": 0.036555
            }
          }
        },
        "is_final": {
          "description": "Every candle the reading uses is final. A final reading changes only if the candles it uses are rebuilt.",
          "type": "boolean",
          "example": true
        },
        "method": {
          "description": "Version of the method: `ma-breadth/1`.",
          "type": "string",
          "example": "ma-breadth/1"
        },
        "n": {
          "description": "The moving average's length in days.",
          "type": "integer",
          "enum": [
            5,
            20,
            50,
            200
          ],
          "example": 50
        },
        "timestamp": {
          "description": "Bucket open time, RFC 3339 UTC.",
          "type": "string",
          "format": "date-time",
          "example": "2026-10-20T00:00:00.000Z"
        },
        "timestamp_ms": {
          "description": "`timestamp` as Unix milliseconds.",
          "type": "integer",
          "format": "int64",
          "example": 1792454400000
        },
        "value_pct": {
          "description": "100 * above / eligible, to 4 decimals. Null when nothing is eligible, never 0.",
          "type": "number",
          "format": "double",
          "nullable": true,
          "example": 34.4633
        }
      }
    },
    "meta": {
      "description": "Response metadata. Every 2xx JSON response carries `meta.request_id`; list payloads add `count`; cursor-paged routes add `has_more` and, when another page follows, `next_cursor`; per-symbol routes add `symbol` and `venue`. Fields that do not apply to a route are omitted.",
      "type": "object",
      "required": [
        "request_id"
      ],
      "properties": {
        "as_of": {
          "description": "Positioning: the 5-minute close the records describe, equal to each record's `window_end`.",
          "type": "string",
          "format": "date-time"
        },
        "built_through": {
          "description": "Trade intent: how far the series is built. A second without a record had no trades up to this instant; after it nothing is known yet.",
          "type": "string",
          "format": "date-time"
        },
        "clamped_to": {
          "description": "The boundary the request's `end` was clamped to, when clamping occurred.",
          "type": "string",
          "format": "date-time",
          "nullable": true
        },
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "finalized_through": {
          "description": "Two-tier datasets (Lighter trades): data at or before this instant is final; later data is preliminary.",
          "type": "string",
          "format": "date-time"
        },
        "has_more": {
          "description": "Cursor-paged routes: whether another page follows. `next_cursor` is present exactly when this is `true`. A final page can be empty when the previous page was exactly full; `has_more` is `false` on it.",
          "type": "boolean"
        },
        "next_cursor": {
          "description": "Opaque cursor for the next page, present exactly when `has_more` is `true`. Pass it back unchanged as `cursor` with the same filters. Do not parse or construct it.",
          "type": "string"
        },
        "notice": {
          "description": "Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "preliminary_row_count": {
          "description": "Number of preliminary rows in this response, on routes that intentionally serve preliminary data (Lighter `/recent`, trade intent).",
          "type": "integer",
          "nullable": true
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        },
        "requested_end": {
          "description": "The `end` the request asked for, echoed when it was clamped to `finalized_through`.",
          "type": "string",
          "format": "date-time",
          "nullable": true
        },
        "symbol": {
          "description": "Per-symbol routes: the canonical public symbol the response describes (for example `BTC`, `xyz:TSLA`, `HYPE-USDC`, `#0`).",
          "type": "string",
          "example": "BTC"
        },
        "venue": {
          "description": "Per-symbol routes: the venue the response describes.",
          "type": "string",
          "enum": [
            "hyperliquid",
            "hip3",
            "hip4",
            "spot",
            "lighter",
            "rh-lighter"
          ],
          "example": "hyperliquid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}
```

## Referenced components

* [MaBreadthReading](https://docs.0xarchive.io/schemas/components/ma-breadth-reading.md)
* [ResponseMeta](https://docs.0xarchive.io/schemas/components/response-meta.md)

## Referenced By

* [`GET /v1/hyperliquid/breadth/above-ma/current`](https://docs.0xarchive.io/schemas/operations/get-breadth-above-ma-current)
* [`GET /v1/hyperliquid/hip3/breadth/above-ma/current`](https://docs.0xarchive.io/schemas/operations/get-hip3-breadth-above-ma-current)


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