This API is in private preview. Target September 2026; timing is subject to change.
Use the native subscription envelope: {"method":"subscribe","subscription":{...}}. Use the same subscription object with "method":"unsubscribe" to close a stream. Acknowledgements use "channel":"subscriptionResponse"; data frames use {"channel":"<type>","data":{...}}.
HyperCore data frames carry additive top-level metadata: subscriptionId, blockHeight, blockTime, and, on replay-capable streams, cursor.
| Field | Type | Description |
|---|---|---|
| channel | string | Subscription-response channel or stream type. |
| data | object | Stream-specific payload. |
| subscriptionId | string | Subscription identifier. |
| blockHeight | integer | Source-block height. |
| blockTime | integer | Source-block time. |
| cursor | string | Opaque resume token on replay-capable streams. |
Native subscriptions use singular coin and user fields. HyperCore's coins, users, builders, intervals, and eventTypes arrays are Alchemy extensions for multi-entity subscriptions. Candle subscriptions include both a coin dimension and an interval dimension.
| Stream | Description |
|---|---|
| activeAssetCtx | Active asset context. |
| allCandles | Candle updates across selected coins and intervals. |
| allFills | Fill updates across selected coins. |
| allIsolatedMarginUpdates | Isolated-margin updates across the available stream scope. |
| allLeverageUpdates | Leverage-setting updates across the available stream scope. |
| allTwapStatusUpdates | TWAP-status updates. |
| allUserNonFundingLedgerUpdates | Non-funding ledger updates. |
| bbo | Best-bid and offer book updates. |
| builderFills | Builder fill updates. |
| builderLiquidation | Builder-context liquidation updates. |
| builderOrderUpdates | Builder order updates. |
| candles | Candle updates for selected coins and intervals. |
| fundingRates | Funding-rate updates. |
| l2Book | L2 book snapshots. |
| l2BookDiff | L2 book differences. |
| l4BookUpdates | L4 order-level updates. |
| liquidationFills | Liquidation fill updates. |
| setOracleUpdates | Oracle updates. |
| tpslUpdates | Take-profit and stop-loss updates. |
| trades | Market-wide trade events; use userFills for the same events scoped to an account. |
| userFills | User fill updates. |
| userIsolatedMarginUpdates | User-context isolated-margin updates. |
| userLeverageUpdates | User-context leverage updates. |
| userNonFundingLedgerUpdates | User non-funding ledger updates. |
| userOrderUpdates | User order updates. |
For connection, resume, and recovery behavior, see connection lifecycle and replay and recovery.