Event:
Endpoint:
Cost: 0.2 credits per event
price_spike Endpoint:
wss://api.struct.to/ws/alerts Cost: 0.2 credits per event
Filters
| Filter | Type | Required | Description |
|---|---|---|---|
condition_ids | string[] | No | Restrict to specific conditions (max 500) |
event_slugs | string[] | No | Restrict to specific events (max 500) |
position_ids | string[] | No | Restrict to specific positions (max 500) |
outcomes | string[] | No | Filter by outcome name, e.g. ["Yes", "No"] (max 500) |
min_probability | number | No | Lower bound for both baseline and current price (0.0-1.0). Useful for excluding moves into resolution extremes |
max_probability | number | No | Upper bound for both baseline and current price (0.0-1.0) |
min_price_change_pct | number | No | Minimum price change percentage (0-100) |
min_txns | integer | No | Minimum number of trades accumulated in the current window before a spike can fire |
min_volume_usd | number | No | Minimum USD volume accumulated in the current window before a spike can fire |
spike_direction | string | No | Direction filter: up, down, or both. Defaults to up when omitted |
window_secs | number | No | Observation window in seconds (1-600). Also acts as the cooldown between fires for the same position (minimum 30s) |
exclude_shortterm_markets | boolean | No | Exclude short-term updown markets from results |