Event:
Cost: 0.2 credits per delivery
position_volume_spike Cost: 0.2 credits per delivery
position_volume_spike event fires when a position’s volume in a timeframe exceeds its recent baseline by your spike ratio. The full payload schema is in the auto-generated Position Volume Spike callback reference; this page documents the filters and matching behavior.
When to use this
- Detect activity surges on a single outcome token rather than a whole market.
- Tune sensitivity by setting how far volume must exceed its baseline.
- Scope alerts to specific outcomes or markets you track.
Subscription filters
Add these to thefilters object when you create the subscription.
| Filter | Type | Description |
|---|---|---|
spike_ratio | number | Volume must exceed its baseline by at least this ratio (must be greater than 1.0). |
window_secs | integer | Look-back window in seconds (1–600). |
position_ids | string[] | Restrict to specific outcome tokens by position ID (max 500). |
condition_ids | string[] | Restrict to specific markets by condition ID (max 500). |
outcomes | string[] | Restrict by outcome name, e.g. ["Yes", "No"] (max 500). |
timeframes | string[] | One or more windows: 1m, 5m, 30m, 1h, 6h, 1d, 24h, 7d, 30d, lifetime. |
Example
Notes
spike_ratiomust be greater than1.0; for example3.0means 3x the recent baseline.