Get current Hyperliquid breadth above session VWAP JSON Schema

Source OpenAPI: 0xArchive API 1.6.1; 151 paths; 141 component schemas. Get the latest validated aggregate percentage of eligible Hyperliquid core perpetual instruments trading above their current UTC-session VWAP. Each instrument contributes one vote; VWAP uses candle quote volume divided by base volume and compares the last completed 1-minute candle close. The session resets at 00:00 UTC. Instruments with no session volume or a last completed candle older than 5 minutes are excluded. Coverage reflects per-instrument eligibility at the calculation cutoff. value_pct is null when no instruments are eligible, never 0. Core perpetual responses always return empty namespaces maps; this route is aggregate-only and does not expose per-symbol VWAPs. Validated snapshots are stored every minute when the calculation passes its invariants; failed or invalid calculations do not create a row. calculated_at is the UTC cutoff used to calculate the validated snapshot, not a source-freshness guarantee. Core history begins 2026-08-24; values before 2026-08-31 13:43 UTC were recomputed from canonical settled candles with a point-in-time registry, not synthesized.

Route Metadata

Field	Value
Method	`GET`
Path	`/v1/hyperliquid/breadth/above-vwap/current`
operationId	`getBreadthAboveVwapCurrent`
Tag	Hyperliquid - Breadth
Family	Hyperliquid Core
Deprecated or legacy	no

Response Contracts

Status 200

Current Hyperliquid breadth snapshot

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getBreadthAboveVwapCurrent response 200",
  "type": "object",
  "properties": {
    "data": {
      "description": "Aggregate percentage of eligible Hyperliquid core perpetual or HIP-3 instruments trading above their current UTC-session VWAP. The same validated snapshot shape is used for both families; per-symbol VWAPs are not served.",
      "type": "object",
      "required": [
        "calculated_at",
        "counts",
        "coverage_ratio",
        "namespaces",
        "session_date",
        "value_pct"
      ],
      "properties": {
        "calculated_at": {
          "description": "UTC calculation cutoff for this validated snapshot. It identifies the cutoff used for included candle data and is not a source-freshness guarantee.",
          "type": "string",
          "format": "date-time"
        },
        "counts": {
          "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
            }
          }
        },
        "coverage_ratio": {
          "description": "Eligible divided by candidates, constrained to the range 0..1.",
          "type": "number",
          "format": "double",
          "minimum": 0,
          "maximum": 1
        },
        "namespaces": {
          "description": "Per-namespace count breakdowns for the shared core and HIP-3 breadth shape. Core perpetual responses always return empty maps. HIP-3 responses use builder namespace keys where counts are nonzero, so an individual map may be empty.",
          "type": "object",
          "required": [
            "above",
            "at",
            "below",
            "eligible"
          ],
          "properties": {
            "above": {
              "description": "Above-VWAP instrument counts by builder namespace for HIP-3; always empty for core perpetuals.",
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "format": "int32",
                "minimum": 0
              }
            },
            "at": {
              "description": "At-VWAP instrument counts by builder namespace for HIP-3; always empty for core perpetuals.",
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "format": "int32",
                "minimum": 0
              }
            },
            "below": {
              "description": "Below-VWAP instrument counts by builder namespace for HIP-3; always empty for core perpetuals.",
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "format": "int32",
                "minimum": 0
              }
            },
            "eligible": {
              "description": "Eligible instrument counts by builder namespace for HIP-3; always empty for core perpetuals.",
              "type": "object",
              "additionalProperties": {
                "type": "integer",
                "format": "int32",
                "minimum": 0
              }
            }
          }
        },
        "session_date": {
          "description": "UTC session date.",
          "type": "string",
          "format": "date"
        },
        "value_pct": {
          "description": "100 times above divided by eligible; null when eligible is zero and never interpret null as 0%.",
          "type": "number",
          "format": "double",
          "nullable": true
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "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"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "notice": {
          "description": "Human-readable advisory about the response. Currently used when the requested window ends before coverage begins for the symbol; may carry other advisories in future.",
          "type": "string"
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

Status 401

Authentication required

application/json

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

OpenAPI example

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

Status 404

Resource not found

application/json

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

OpenAPI example

{
  "code": 404,
  "error": "Resource not found"
}

Status 429

Rate limit exceeded

application/json

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

OpenAPI example

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

API reference

SDKs & tooling

AI & agents

Get current Hyperliquid breadth above session VWAP JSON Schema

Route Metadata

Response Contracts

Status 200

application/json

Status 401

application/json

OpenAPI example

Status 404

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Response Contracts

​Status 200

​application/json

​Status 401

​application/json

OpenAPI example

​Status 404

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Response Contracts

Status 200

application/json

Status 401

application/json

Status 404

application/json

Status 429

application/json