Get HIP-3 breadth above session VWAP history

curl --request GET \
  --url https://api.0xarchive.io/v1/hyperliquid/hip3/breadth/above-vwap \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.0xarchive.io/v1/hyperliquid/hip3/breadth/above-vwap', 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/hip3/breadth/above-vwap"

	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": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

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

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

GET

https://api.0xarchive.io

hyperliquid

hip3

breadth

above-vwap

Get HIP-3 breadth above session VWAP history

curl --request GET \
  --url https://api.0xarchive.io/v1/hyperliquid/hip3/breadth/above-vwap \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.0xarchive.io/v1/hyperliquid/hip3/breadth/above-vwap', 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/hip3/breadth/above-vwap"

	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": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

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

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

API key required. Send X-API-Key with this request. See REST authentication.

Shared request rules

Machine schema

Open the generated operation schema for machine-readable request and response details.

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Query Parameters

start

integer<int64>

Start timestamp in Unix milliseconds. Defaults to 24h ago.

end

integer<int64>

End timestamp in Unix milliseconds. Defaults to now.

cursor

string

Cursor timestamp in Unix milliseconds. Pass meta.next_cursor from the prior response; results after this timestamp are returned.

limit

integer

default:100

Maximum number of snapshots (default: 100, max: 1000).

Required range: x <= 1000

interval

enum<string>

Optional aggregation interval. Downsampled intervals select the last stored snapshot in each bucket; percentages are never averaged.

Available options:

5m,

15m,

30m,

1h,

4h,

1d

Response

Historical HIP-3 breadth snapshots

success

boolean

Example:

true

data

object[]

Hide child attributes

data.session_date

string<date>

required

UTC session date.

data.calculated_at

string<date-time>

required

Timestamp when this snapshot was calculated.

data.value_pct

number<double> | null

required

100 times above divided by eligible; null when eligible is zero.

data.coverage_ratio

number<double>

required

Eligible divided by candidates, constrained to the range 0..1.

Required range: 0 <= x <= 1

data.counts

object

required

Auditable counts behind an aggregate HIP-3 breadth snapshot.

Hide child attributes

data.counts.candidates

integer<int32>

required

Candidate instruments considered for the snapshot.

Required range: x >= 0

data.counts.eligible

integer<int32>

required

Eligible instruments included in the headline percentage.

Required range: x >= 0

data.counts.above

integer<int32>

required

Eligible instruments trading above their current UTC-session VWAP.

Required range: x >= 0

data.counts.at

integer<int32>

required

Eligible instruments at their current UTC-session VWAP.

Required range: x >= 0

data.counts.below

integer<int32>

required

Eligible instruments trading below their current UTC-session VWAP.

Required range: x >= 0

data.counts.excluded_no_session_volume

integer<int32>

required

Candidates excluded because the current UTC session has no qualifying volume.

Required range: x >= 0

data.counts.excluded_stale_price

integer<int32>

required

Candidates excluded because their price was stale.

Required range: x >= 0

data.namespaces

object

required

Per-builder-namespace count breakdowns keyed by namespace.

Hide child attributes

data.namespaces.eligible

object

required

Eligible instrument counts by builder namespace.

Hide child attributes

data.namespaces.eligible.{key}

integer<int32>

Required range: x >= 0

data.namespaces.above

object

required

Above-VWAP counts by builder namespace.

Hide child attributes

data.namespaces.above.{key}

integer<int32>

Required range: x >= 0

data.namespaces.at

object

required

At-VWAP counts by builder namespace.

Hide child attributes

data.namespaces.at.{key}

integer<int32>

Required range: x >= 0

data.namespaces.below

object

required

Below-VWAP counts by builder namespace.

Hide child attributes

data.namespaces.below.{key}

integer<int32>

Required range: x >= 0

API reference

SDKs & tooling

AI & agents

Get HIP-3 breadth above session VWAP history

Authorizations

Query Parameters

Response