> ## Documentation Index
> Fetch the complete documentation index at: https://docs.struct.to/llms.txt
> Use this file to discover all available pages before exploring further.

# Position Volume Spike

> Get notified when a position's volume exceeds its baseline by a configured ratio.

<Note>
  **Event:** `position_volume_spike` \
  **Endpoint:** `wss://api.struct.to/ws/alerts` \
  **Cost:** 0.2 credits per event
</Note>

Get notified when a position's volume exceeds its baseline by a configured ratio. The `spike_ratio` filter is required and defines the volume multiplier threshold.

## Filters

| Filter | Type | Required | Description |
| - | - | - | - |
| `spike_ratio` | number | Yes | Volume multiplier threshold, must be greater than 1.0 (e.g. 2.0 = 2x baseline) |
| `position_ids` | string\[] | No | Restrict to specific positions (max 500) |
| `condition_ids` | string\[] | No | Restrict to specific conditions (max 500) |
| `outcomes` | string\[] | No | Filter by outcome name, e.g. `["Yes", "No"]` (max 500). Note that multiple choice and esports markets often have non-standard outcome names (e.g. team names). |
| `timeframes` | string\[] | No | Timeframe windows: `1m`, `5m`, `30m`, `1h`, `6h`, `24h`, `7d`, `30d` (max 500) |
| `window_secs` | number | No | Window reset interval in seconds (1-600) |

## Subscribe

```json theme={null}
{
  "op": "subscribe",
  "event": "position_volume_spike",
  "spike_ratio": 2.5,
  "timeframes": ["5m", "30m"]
}
```

## Response

```json theme={null}
{
  "event": "position_volume_spike",
  "timestamp": 1775913505260,
  "data": {
    "position_id": "0xabc123",
    "condition_id": "0x1234567890abcdef",
    "question": "Will the Fed cut rates in December?",
    "market_slug": "fed-decision-december-2028",
    "event_slug": "us-presidential-election-2028",
    "image_url": "https://polymarket-upload.s3.us-east-2.amazonaws.com/example.png",
    "outcome": "Yes",
    "outcome_index": 0,
    "timeframe": "5m",
    "current_volume_usd": 8750.00,
    "snapshot_volume_usd": 3200.00,
    "delta_volume_usd": 5550.00,
    "spike_pct": 173.44,
    "txns": 28,
    "fees": 87.50
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.