Get HIP-3 breadth above the moving average history

Authorizations

X-API-Key

string

header

required

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

Headers

0xArchive-Version

enum<string>

Selects the 2026-10 response contract. Send 2026-10-01; any dated version on or after it selects the same shapes. Without the header every response keeps its existing shape. With it:

The data quality routes, /v1/status/coverage and /v1/symbols answer the standard {success, data, meta} envelope.
Record times that are integer milliseconds by default become RFC 3339 UTC strings with millisecond precision, and the integer moves to a *_ms field: L4 resting-order timestamp (timestamp_ms), CVD buckets, HIP-3 oracle reads, Lighter and Lighter on Robinhood Chain liquidations and liquidation volume. Levels and trigger-levels snapshot_ts become RFC 3339 with snapshot_ts_ms.
Error bodies carry the contract error_code names: invalid_parameter instead of invalid_query_params and invalid_path_params, historical_depth_exceeded instead of history_window_exceeded, and historical_range_exceeded instead of request_range_exceeded; a malformed cursor that fails to parse answers 400 invalid_cursor instead of invalid_query_params. With 0xArchive-Version: 2026-10-01, malformed cursors on trades, liquidations, L2 and L4 diffs, order history, TP/SL and order-flow routes answer 400 invalid_cursor. Without the header, the first six route families treat a malformed cursor as no cursor and return the first page; order flow answers 400 invalid_query_params. Malformed trade time inputs answer 400 invalid_time_range with the header and 400 invalid_query_params without it.

The response echoes the selected version in its own 0xArchive-Version header.

Available options:

2026-10-01

Example:

"2026-10-01"

Query Parameters

enum<integer>

required

The moving average's length in days. Required; there is no default, because each length answers a different question and starts on its own date.

Available options:

5,

20,

50,

200

start

Start of the window, inclusive. Defaults to 24 hours before end, so set it explicitly when paging: the default moves with the clock. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z. An instant: Unix milliseconds, or an RFC 3339 string such as 2026-01-01T00:00:00Z (encode a + offset as %2B). An unparsable value answers 400 invalid_time_range.

Example:

1767225600000

end

End of the window, inclusive. Defaults to now. Accepts Unix milliseconds or an RFC 3339 UTC string such as 2026-01-01T00:00:00Z. An instant: Unix milliseconds, or an RFC 3339 string such as 2026-01-01T00:00:00Z (encode a + offset as %2B). An unparsable value answers 400 invalid_time_range.

Example:

1767225600000

interval

enum<string>

default:1m

Bucket width (default: 1m), on UTC epoch boundaries. Each bucket carries its last reading; percentages are never averaged.

Available options:

1m,

5m,

15m,

30m,

1h,

4h,

1d

cursor

string

Opaque pagination cursor: pass meta.next_cursor from the previous page unchanged, with the same filters. Omit it for the first page.

limit

integer

default:100

Buckets per page (default: 100, max: 1,000). A larger value is read as 1,000.

Required range: x <= 1000

Response

Moving-average breadth readings

API response containing moving-average breadth readings, one per bucket.

success

boolean

Example:

true

data

object[]

Hide child attributes

data.timestamp

string<date-time>

required

Bucket open time, RFC 3339 UTC.

Example:

"2026-10-20T00:00:00.000Z"

data.timestamp_ms

integer<int64>

required

timestamp as Unix milliseconds.

Example:

1792454400000

data.calculated_at

string<date-time>

required

The reading's instant: the bucket's end, or for the bucket still forming the newest settled minute, about 4 minutes before now.

Example:

"2026-10-21T00:00:00.000Z"

data.calculated_at_ms

integer<int64>

required

calculated_at as Unix milliseconds.

Example:

1792540800000

data.n

enum<integer>

required

The moving average's length in days.

Available options:

5,

20,

50,

200

Example:

50

data.method

string

required

Version of the method: ma-breadth/1.

Example:

"ma-breadth/1"

data.value_pct

number<double> | null

required

100 * above / eligible, to 4 decimals. Null when nothing is eligible, never 0.

Example:

34.4633

data.coverage_ratio

number<double>

required

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.

Required range: 0 <= x <= 1

Example:

0.8009

data.counts

object

required

The counts a moving-average breadth reading is made from. above + at + below = eligible; eligible + excluded_stale_price + excluded_short_history = candidates.

Hide child attributes

data.counts.candidates

integer

required

Every perp the venue has listed, from its first one-minute candle on, delisted perps included.

Example:

221

data.counts.eligible

integer

required

Candidates with a recent price and n days of history: the denominator of value_pct.

Example:

177

data.counts.above

integer

required

Eligible perps whose price is above their n-day moving average.

Example:

61

data.counts.at

integer

required

Eligible perps whose price equals their n-day moving average.

Example:

0

data.counts.below

integer

required

Eligible perps whose price is below their n-day moving average.

Example:

116

data.counts.excluded_stale_price

integer

required

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.

Example:

43

data.counts.excluded_short_history

integer

required

Candidates younger than n UTC days before the reading's day.

Example:

1

data.distance

object

required

Quartiles of price / average - 1 over the eligible perps, to 6 decimals, linear interpolation. Each is null when nothing is eligible, never 0.

Hide child attributes

data.distance.p25

number<double> | null

required

Example:

-0.09803

data.distance.median

number<double> | null

required

Example:

-0.027606

data.distance.p75

number<double> | null

required

Example:

0.036555

data.is_final

boolean

required

Every candle the reading uses is final. A final reading changes only if the candles it uses are rebuilt.

Example:

true

Endpoint reference

Requests and responses

Datasets

Venues

OpenAPI and schemas

Guides

Get HIP-3 breadth above the moving average history

Authorizations

Headers

Query Parameters

Response