List webhook event types

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"

Response

The served webhook event catalog

API response containing the served webhook event catalog.

success

boolean

required

Example:

true

data

object[]

required

Hide child attributes

data.type

string

required

Event type identifier. Send this as event_type when creating a subscription.

Example:

"market.liquidation"

data.schema_version

integer

required

Version of the delivered payload shape for this event type.

Example:

1

data.live

boolean

required

True when the type accepts subscriptions. A type that is published but not yet live is refused at create time.

Example:

true

data.scope

enum<string>

required

Who the event is about. public is market wide, user is your own account and platform activity, and addresses reports only on wallets on your watched list.

Available options:

public,

user,

addresses

Example:

"public"

data.venues

string[]

required

Venues the type covers. Empty when the type is not venue scoped.

Example:

["hyperliquid", "hip3", "lighter"]

data.filters

string[]

required

Filter keys the subscription config accepts for this type. A key that is not listed here is refused rather than ignored.

Example:

["venue", "symbols"]

data.params

object

required

Tunable parameters, keyed by parameter name.

Hide child attributes

data.params.{key}

object

A tunable parameter declared by an event type. Values sent under params are validated against this declaration, and any declared parameter left unset is stored at its default.

Hide child attributes

data.params.{key}.type

enum<string>

Value type the parameter accepts.

Available options:

integer,

number,

string,

array_of_number

Example:

"integer"

data.params.{key}.unit

string

Unit the value is expressed in, when it has one.

Example:

"s"

data.params.{key}.default

any

Value used when the parameter is not supplied.

Example:

3600

data.params.{key}.min

number

Lowest accepted value, when the parameter is bounded below.

Example:

60

data.params.{key}.max

number

Highest accepted value, when the parameter is bounded above.

Example:

86400

data.params.{key}.enum

any[]

Accepted values, when the parameter is a fixed choice.

data.params.{key}.description

string

What the parameter changes.

data.metrics

object

required

Metrics carried by the event, keyed by metric name. A condition may only reference a metric declared here.

Hide child attributes

data.metrics.{key}

object

A metric an event carries, and therefore a metric a subscription condition may be written against.

Hide child attributes

data.metrics.{key}.type

enum<string>

Value type of the metric. It decides which operators a condition on this metric may use. An enum metric lists its accepted values in values.

Available options:

number,

integer,

string,

boolean,

timestamp,

enum

Example:

"number"

data.metrics.{key}.unit

string

Unit the metric is expressed in, when it has one.

Example:

"USD"

data.metrics.{key}.values

string[]

Accepted values of an enum metric. Conditions are checked against this list.

data.metrics.{key}.description

string

What the metric measures, including when it is null.

data.cost_floor

object | null

required

The smallest occurrence this type reports at all, below which nothing is detected. Null when the type has no floor.

Hide child attributes

data.cost_floor.metric

string

required

Metric the floor applies to.

Example:

"notional_usd"

data.cost_floor.min

number

required

Lowest value still reported.

Example:

100

data.cost_floor.unit

string

Unit of min when it is not the metric's own unit.

Example:

"HYPE"

data.cost_floor.note

string

How the floor applies, when it needs saying.

data.latency_class

enum<string>

required

Rough delivery latency for the type, measured from the occurrence to the first delivery attempt.

Available options:

seconds,

minutes

Example:

"seconds"

data.description

string

required

What the event reports and what one occurrence means.

Example:

"A liquidation on a covered venue."

data.filters_example

object

required

A worked example of a config for this type.

data.operators

object

required

Operator vocabulary, grouped: number (metric types number and integer), text (string and enum), boolean, timestamp, and any, which applies to every metric. A condition on a metric may use the operators of its group or of any.

Hide child attributes

data.operators.{key}

string[]

Guides

API reference

List webhook event types

Authorizations

Headers

Response