Docs / Scan / Subscribe to a scan query POST https://api.tickerbot.io /v2/scan/subscribe ⎘
Subscribes to a free-form `q` (same grammar as `GET /v2/scan`). The webhook delivers the match set every time it changes (tickers entering or leaving). Optionally scope to a `universe`. Max `q` length is 1500 chars.
Plan access Included on every plan.
Cadence Hobby 5m · Pro 1m · Scale 1m · Enterprise 1m.
Capacity Unlimited on every paid plan.
Status codes 200Webhook subscription created.
curl Python Node
Copy curl -X POST "https://api.tickerbot.io/v2/scan/subscribe" \
-H "Authorization: Bearer YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"q": "gap_up AND small_cap AND high_volume_alert"
}'Try it
This endpoint requires an authenticated key. Sign in to run it from your dashboard, or get a free key. tickerbot.io/dashboard .
Sample response
{
"id": "wh_eW9rTq-c52v",
"name": "scan: gap_up AND small_cap AND high_volume_alert",
"q": "gap_up AND small_cap AND high_volume_alert",
"cadence": "5m",
"target_url": "https://example.com/hook",
"delivery": "webhook",
"status": "pending_verification",
"subscription_origin": { "type": "scan", "ref": "q", "condition": null },
"created_at": 1737580800
}