Skip to main content

Documentation Index

Fetch the complete documentation index at: https://hypernode-docs.polynode.dev/llms.txt

Use this file to discover all available pages before exploring further.

Filters narrow the event stream to only matching events. All filter dimensions use AND logic: if multiple filters are specified, an event must match all of them.

​
Filter fields

FieldTypeMatch LogicCase
action_typesstring[]Match on event typeCase-sensitive
addressesstring[]Match on event userCase-insensitive
assetsstring[]Match on event assetCase-insensitive
asset_idsnumber[]Match on event asset_idExact numeric
buildersstring[]Match on fill data.builder (HIP-3 builder address)Case-insensitive
liquidations_onlybooleanMatch fills where data.liquidation is presentN/A

​
Behavior

  • Omitted filter = matches everything (no restriction on that dimension)
  • Empty array [] = matches nothing
  • No filters field = firehose (all events)

​
Umbrella types

Some type names match a group of related events:
Filter valueMatches
"order"order, order_filled, order_canceled, order_rejected
"fill"fill
"cancel"cancel
"cancelByCloid"cancelByCloid
"batchModify"batchModify
Use exact type names like "order_filled" or "order_rejected" to match a single event type.
There is no order_open type. New resting orders use the type "order" with data.status: "open". To get only new resting orders, subscribe to "order" and filter client-side by data.status.

​
Examples

All orders and fills (most common): 
{"action": "subscribe", "filters": {"action_types": ["order", "fill"]}}
Returns: every new order, filled order, canceled order, rejected order, and every trade execution. Only BTC orders: 
{"action": "subscribe", "filters": {"action_types": ["order"], "assets": ["BTC"]}}
Track a specific wallet: 
{"action": "subscribe", "filters": {"addresses": ["0xd071d6d6ea52f5aa34b79e47f908ee48c8215837"]}}
Returns all events from this address across both consensus layers. Pre-consensus cancels only: 
{"action": "subscribe", "filters": {"action_types": ["cancel", "cancelByCloid"]}}
These arrive before the cancel is committed to a block. Full firehose (everything): 
{"action": "subscribe"}
~6,500 events per second on mainnet. Includes both pre-consensus and confirmed events. Prediction market activity: 
{"action": "subscribe", "filters": {"assets": ["#39890"]}}
Track a specific outcome token. Use the # coin name format. All fills across every market (allFills firehose): 
{"action": "subscribe", "filters": {"action_types": ["fill"]}}
Every trade execution network-wide. Useful for analytics, VWAP calculations, and market-wide tracking. Liquidations only: 
{"action": "subscribe", "filters": {"action_types": ["fill"], "liquidations_only": true}}
Only fills that were part of a liquidation event. Each matching fill carries a data.liquidation object with liquidatedUser, markPx, and method. Both sides of the liquidation (liquidated user and liquidator) appear as separate fills with the same tid. Fills for a specific builder (HIP-3): 
{
  "action": "subscribe",
  "filters": {
    "action_types": ["fill"],
    "builders": ["0x1924b8561eef20e70ede628a296175d358be80e5"]
  }
}
Only fills attributed to the given builder address via HIP-3. Useful for builder DEX operators tracking their own flow in real-time. Monitor liquidations for a specific wallet: 
{
  "action": "subscribe",
  "filters": {
    "action_types": ["fill"],
    "addresses": ["0xabc..."],
    "liquidations_only": true
  }
}
Alert-style feed for when a specific wallet is liquidated.