Webhooks - Previews

Estimate a webhook subscription

How often would this configuration have fired over the last lookback_days? Returns the total, a count per day of the window, the median and busiest day, the distribution of the event's primary metric, a ladder of what the daily rate would be at other thresholds, and a sample of real matches, so a threshold can be chosen against history rather than guessed. The configuration is validated and normalised exactly as a create. Nothing is stored and no delivery is sent. Available for account.fill, account.transfer, account.liquidated, market.liquidation, market.pga_payment, hip4.settlement, market.liquidation_burst, market.oi_delta, oracle.jump and market.funding_flip; another type is refused with the list of the ones that work. An address scoped type needs at least one watched wallet to report on. Authenticate with an API key or a signed-in dashboard session. Available on every plan, including Free, and metered like the market data it returns. At most six estimates and dry-runs a minute per account, shared between the two.

post/v1/webhooks/subscriptions/estimate

Request

  • Base URL: https://api.0xarchive.io
  • URL: https://api.0xarchive.io/v1/webhooks/subscriptions/estimate
  • Auth: API key in header X-API-Key

Request body

event_typestring required

Event type to evaluate.

lookback_daysinteger

Days of history to evaluate, ending now.

Example request

{
  "event_type": "market.liquidation",
  "config": {
    "symbols": [
      "BTC",
      "ETH"
    ],
    "addresses": [
      "0x6b9e773128f453f5c2c60935ee2de2cbc5390a24"
    ],
    "params": {
      "max_age_s": 3600
    },
    "conditions": [
      {
        "metric": "notional_usd",
        "op": "greater_than_or_equal",
        "value": 100000
      }
    ],
    "min_notional_usd": 100000
  },
  "lookback_days": 7
}

Response

How often the configuration would have fired

successboolean

Example response

{
  "success": true,
  "data": {
    "event_type": "market.liquidation",
    "days": 7,
    "total": 84,
    "per_day": [
      {
        "date": "2026-09-19",
        "count": 12
      }
    ],
    "per_day_p50": 11,
    "per_day_max": 26,
    "primary_metric": "notional_usd",
    "ladder": [
      {
        "value": 250000,
        "per_day": 3.4
      }
    ],
    "distribution": {
      "n": 842,
      "p50": 18400,
      "p90": 132000,
      "p99": 910000,
      "max": 4210000
    },
    "basis": {
      "mode": "exact"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.