DocsAPI ReferencePlatformAlerts

Alerts

Read your alert definitions over the API: screener alerts and position alerts, with their delivery channels.

List alerts

GET/alerts

Read-only: alerts are created and edited in the dashboard (screener alerts are written in natural language and compiled server-side), and this endpoint gives your integration a live view of what is configured and firing.

curl -H "Authorization: Bearer qw_live_YOUR_KEY" \
  "https://quantwheel.com/api/v1/alerts"

200 OK

{
  "screenerAlerts": [
    {
      "id": "alr_m2k1x",
      "description": "CSPs on my watchlist with rating above 90 and yield over 0.5%/week",
      "summary": "High-rating CSPs",
      "watchlistId": "wl_88a",
      "createdAt": "2026-06-02T09:12:00.000Z",
      "timesFired": 14,
      "channels": { "email": true, "discord": false, "sms": false }
    }
  ],
  "positionAlerts": [
    {
      "id": "pal_71b",
      "name": "Roll pressure",
      "type": "roll",
      "enabled": true,
      "isDefault": true,
      "criteria": { "...": "rule thresholds" },
      "channels": { "email": true, "discord": true },
      "strategyKey": null,
      "createdAt": "2026-05-10T18:00:00.000Z"
    }
  ]
}

Alert types

Kind	Fires when
Screener alert	A contract matching your saved screener rule appears on a watchlist.
`roll`	A short leg comes under roll pressure per your strategy's criteria.
`covered_call`	A covered-call opportunity on your shares meets the ROI threshold.
`expiration`	An open leg approaches expiry within your DTE window.
`early_close`	An early close would capture most of the remaining premium.
`split`	A stock split affects one of your positions.

Delivery

Webhooks: coming soon

Alerts deliver via email, Discord and SMS today. Signed webhook delivery to your own endpoint is on the roadmap - until then, poll /gex/events for positioning changes or read alert definitions here.

Historical Data

AI Explanations