Event:
Cost: 0.2 credits per delivery
price_spike Cost: 0.2 credits per delivery
price_spike event fires when a position’s raw trade price (not enriched probability) changes by at least your configured percentage within a look-back window. The full payload schema is in the auto-generated Price Spike callback reference; this page documents the filters and matching behavior.
When to use this
- Track abrupt moves in the underlying trade price rather than the enriched probability.
- Alert on price swings only within a probability band you care about.
- Filter out thin moves by requiring minimum transaction and volume activity.
Subscription filters
Add these to thefilters object when you create the subscription.
| Filter | Type | Description |
|---|---|---|
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). |
event_slugs | string[] | Restrict to specific events by slug (max 500). |
outcomes | string[] | Restrict by outcome name, e.g. ["Yes", "No"] (max 500). |
min_price_change_pct | number | Minimum price change, as a percentage. |
min_probability | number | Minimum outcome probability, 0.0–1.0. |
max_probability | number | Maximum outcome probability, 0.0–1.0. |
min_txns | integer | Minimum transaction count. |
min_volume_usd | number | Minimum traded volume in USD. |
spike_direction | string | Direction to match: up, down, or both. |
window_secs | integer | Look-back window in seconds (1–600). |
exclude_shortterm_markets | boolean | Exclude short-term Up/Down markets. |
Example
Notes
window_secssets the look-back window (1–600seconds) over which the change is measured.spike_directioncontrols which moves match:up,down, orboth. Defaults toupwhen omitted.