Event:
Cost: 0.2 credits per delivery
price_threshold Cost: 0.2 credits per delivery
price_threshold event fires when an outcome’s price (implied probability) crosses a target level you set. It is edge-triggered: it fires once on the crossing, not on every trade that stays past the level. The full payload schema is in the auto-generated Price Threshold callback reference; this page documents the filters and matching behavior.
When to use this
- Alert the moment an outcome crosses up through a level (e.g. YES reaches 75%) or down through one (e.g. YES falls to 25%).
- Build one-time triggers that delete themselves after firing, with
one_shot. - Catch positions that are already past your target when you subscribe, with
fire_if_already_past.
Defining the threshold
Setmin_probability for an upward target (fire when the price crosses up to ≥ that value) and max_probability for a downward target (fire when the price crosses down to ≤ that value). At least one is required; set both to watch a position from either side.
By default the event waits for a real crossing: it needs a prior observation on the other side of the target before it fires. Set fire_if_already_past to fire immediately when the first observed price is already past the target.
Subscription filters
Add these to thefilters object when you create the subscription. At least one of min_probability or max_probability is required.
| Filter | Type | Description |
|---|---|---|
min_probability | number | Upward target, 0.0–1.0. Fire when the price crosses up to ≥ this value (e.g. 0.75). |
max_probability | number | Downward target, 0.0–1.0. Fire when the price crosses down to ≤ this value (e.g. 0.25). |
one_shot | boolean | Delete the subscription after its first delivery (fire-and-delete). Requires position_ids or condition_ids. Defaults to false. |
fire_if_already_past | boolean | Fire immediately if the first observed price is already past the target, with no prior baseline. Defaults to false. |
condition_ids | string[] | Restrict to specific markets by condition ID (max 500). |
position_ids | string[] | Restrict to specific outcome tokens by position ID (max 500). |
outcomes | string[] | Restrict by outcome name, e.g. ["Yes", "No"] (max 500). |
position_outcome_indices | number[] | Restrict by outcome index: 0 (Yes/Up) or 1 (No). |
event_slugs | string[] | Restrict to specific events by slug (max 500). |
tags | string[] | Restrict to markets carrying any of these tags or category names, case-insensitive (max 500). |
series_slugs | string[] | Restrict to markets in any of these series by slug, case-insensitive (max 500). |
exclude_shortterm_markets | boolean | Exclude short-term Up/Down markets. |
Example
Fire once when a specific market’s YES outcome crosses up through 75%, then delete the subscription:Notes
- The event is edge-triggered: it fires on the transition past the target, then re-arms once the price moves back to the other side (unless
one_shotdeleted the subscription). - The payload reports the crossing
direction("up"or"down"), thethresholdthat was crossed, andprevious_price(the baseline the crossing was measured from). one_shotrequiresposition_idsorcondition_idsso the subscription targets a bounded set of markets.