curl --request GET \
--url https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": {
"session_date": "2023-12-25",
"calculated_at": "2023-11-07T05:31:56Z",
"value_pct": 123,
"coverage_ratio": 0.5,
"counts": {
"candidates": 1,
"eligible": 1,
"above": 1,
"at": 1,
"below": 1,
"excluded_no_session_volume": 1,
"excluded_stale_price": 1
},
"namespaces": {
"eligible": {},
"above": {},
"at": {},
"below": {}
}
},
"meta": {
"count": 123,
"next_cursor": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"coverage_from": "2023-11-07T05:31:56Z",
"notice": "<string>"
}
}{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}{
"code": 404,
"error": "Resource not found"
}{
"code": 429,
"error": "Rate limit exceeded"
}Get current Hyperliquid breadth above session VWAP
0xArchive API reference for Get current Hyperliquid breadth above session VWAP. Includes route metadata, schemas, examples, and implementation notes.
curl --request GET \
--url https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.0xarchive.io/v1/hyperliquid/breadth/above-vwap/current"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"data": {
"session_date": "2023-12-25",
"calculated_at": "2023-11-07T05:31:56Z",
"value_pct": 123,
"coverage_ratio": 0.5,
"counts": {
"candidates": 1,
"eligible": 1,
"above": 1,
"at": 1,
"below": 1,
"excluded_no_session_volume": 1,
"excluded_stale_price": 1
},
"namespaces": {
"eligible": {},
"above": {},
"at": {},
"below": {}
}
},
"meta": {
"count": 123,
"next_cursor": "<string>",
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"coverage_from": "2023-11-07T05:31:56Z",
"notice": "<string>"
}
}{
"code": 401,
"error": "Missing or invalid API key. Provide X-API-Key header."
}{
"code": 404,
"error": "Resource not found"
}{
"code": 429,
"error": "Rate limit exceeded"
}X-API-Key with this request. See REST authentication.Shared request rules
Shared request rules
Machine schema
Machine schema
Authorizations
API key for authentication. Get yours at https://0xarchive.io/dashboard
Response
Current Hyperliquid breadth snapshot
true
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.
Hide child attributes
Hide child attributes
UTC session date.
UTC calculation cutoff for this validated snapshot. It identifies the cutoff used for included candle data and is not a source-freshness guarantee.
100 times above divided by eligible; null when eligible is zero and never interpret null as 0%.
Eligible divided by candidates, constrained to the range 0..1.
0 <= x <= 1Auditable counts behind an aggregate Hyperliquid core perpetual or HIP-3 breadth snapshot.
Hide child attributes
Hide child attributes
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.
x >= 0Eligible instruments included in the headline percentage.
x >= 0Eligible instruments trading above their current UTC-session VWAP.
x >= 0Eligible instruments at their current UTC-session VWAP.
x >= 0Eligible instruments trading below their current UTC-session VWAP.
x >= 0Candidates excluded because the current UTC session has no qualifying volume.
x >= 0Candidates 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.
x >= 0Per-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.
Hide child attributes
Hide child attributes
Response metadata
Hide child attributes
Hide child attributes
Number of records returned
Cursor for pagination (timestamp). Use this value as the cursor parameter to fetch the next page of results.
Unique request ID for support
Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.
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.
Was this page helpful?