start and end are Unix timestamps in milliseconds. If omitted, start defaults independently to now minus 24 hours and end defaults to now; the start default is not derived from a supplied end. The optional interval downsamples by selecting the last stored snapshot in each bucket; percentages are never averaged because the denominator can vary. The optional cursor is an epoch-millisecond timestamp from meta.next_cursor and is exclusive. 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 each validated snapshot, not a source-freshness guarantee. HIP-3 history begins 2026-08-28; there is no pre-launch history.
Route Metadata
| Field | Value |
|---|---|
| Method | GET |
| Path | /v1/hyperliquid/hip3/breadth/above-vwap |
| operationId | getHip3BreadthAboveVwap |
| Tag | HIP-3 Builder Perps - Breadth |
| Family | HIP-3 |
| Deprecated or legacy | no |
Human endpoint reference
OpenGET /v1/hyperliquid/hip3/breadth/above-vwap for authentication, parameters, responses, and examples.
Request Parameters
Query Parameters
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3BreadthAboveVwap query parameters",
"type": "object",
"properties": {
"start": {
"description": "Start timestamp in Unix milliseconds. Defaults independently to now minus 24 hours; this default is not derived from a supplied `end`.",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"end": {
"description": "End timestamp in Unix milliseconds. Defaults to now.",
"type": "integer",
"format": "int64",
"x-parameter-location": "query"
},
"cursor": {
"description": "Cursor timestamp in Unix milliseconds. Pass `meta.next_cursor` from the prior response; results after this timestamp are returned.",
"type": "string",
"x-parameter-location": "query"
},
"limit": {
"description": "Maximum number of snapshots (default: 100, max: 1000).",
"type": "integer",
"default": 100,
"maximum": 1000,
"x-parameter-location": "query"
},
"interval": {
"description": "Optional aggregation interval. Downsampled intervals select the last stored snapshot in each bucket; percentages are never averaged.",
"type": "string",
"enum": [
"1m",
"5m",
"15m",
"30m",
"1h",
"4h",
"1d"
],
"x-parameter-location": "query"
}
}
}
Response Contracts
Status 200
Historical HIP-3 breadth snapshotsapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3BreadthAboveVwap response 200",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"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"
},
"has_more": {
"description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
"type": "boolean"
},
"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. 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"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"symbol": {
"description": "Present on per-symbol routes: the symbol the response covers.",
"type": "string"
},
"venue": {
"description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
"type": "string"
}
}
},
"success": {
"type": "boolean",
"example": true
}
}
}
Status 400
Invalid requestapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3BreadthAboveVwap 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"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 400,
"error": "Failed to deserialize query string: limit: invalid digit found in string",
"error_code": "invalid_query_params",
"param": "limit",
"request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05",
"success": false
}
Status 401
Authentication requiredapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3BreadthAboveVwap 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"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 401,
"error": "Missing authentication credentials. Provide X-API-Key header or Bearer token.",
"error_code": "unauthorized",
"request_id": "71ed4b6f-63ef-4ae1-a123-07ffa47c1c14",
"success": false
}
Status 429
Rate limit exceededapplication/json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "getHip3BreadthAboveVwap 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"
},
"param": {
"description": "The parameter at fault, when the error is about one parameter.",
"type": "string"
},
"request_id": {
"description": "Unique request ID for support",
"type": "string",
"format": "uuid"
},
"success": {
"description": "Always false on an error.",
"type": "boolean",
"example": false
}
}
}
OpenAPI example
{
"code": 429,
"error": "Rate limit exceeded"
}