View as markdown
Endpoints · Scan

Subscribe to a scan query

POSThttps://api.tickerbot.io/v2/scan/subscribe

Subscribes to a free-form q (same grammar as POST /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. Response includes a test_url — subscribing does NOT auto-fire anything at your endpoint; call it to send a real-shape webhook.fired POST instantly and validate your receiver.

Custom signals referenced in q are expanded and frozen into the webhook at creation — editing the signal later will not change this subscription (re-subscribe to apply). See Create a custom signal.

Plan access

Paid plans (Hobby and above).

Cadence

Real-time on every paid plan — evaluated on every data refresh (~1×/min), so a match is delivered within seconds of it landing. Optionally throttle a webhook to hourly or at-market-open.

Capacity

Hobby 10 · Pro 100 · Scale & Enterprise unlimited.

Body parameters

stringrequired

WHERE-clause expression using signal/column names. Max 1500 chars. See the schema for columns + flags you can compose.

string

System or user-owned universe to scope the scan (e.g. `top_100`).

string

https:// URL to POST when the match set changes. Omit for in-app delivery.

string

Delivery channel. `webhook` (POST to `target_url`), `discord` (post an embed to `discord_url`), `in_app` (dashboard only), or `mobile_push` (notify a phone signed in to the Tickerbot mobile app; requires a `device_id` from `POST /v2/devices/register`). Inferred when omitted: `webhook` if `target_url` is set, `discord` if `discord_url` is set, else `in_app`. `slack` is reserved and returns `501`. See the Delivery channels guide.

string

Discord incoming-webhook URL (`https://discord.com/api/webhooks/…`). Required when `channel` is `discord`. Stored as a posting credential and stripped from list/get responses, which set `channel_config_present: true` instead.

string

`realtime` (the default) is evaluated on every data refresh (~1×/min); `hourly` and `nyse_open` throttle to a batch schedule. `1m` is a deprecated alias for `realtime`.

string

Human-readable label (up to 80 chars). Defaults to `scan: <q>`.

string

Comma-separated extra columns to include in each fired payload match row, beyond the standard set (`ticker`, `name`, `asset_type`, `price`, `day_change_pct`, `market_cap`). Each must be a real column; an unknown column is rejected at creation.

Status codes

200
Webhook subscription created.
400
bad_request or invalid_query — missing/malformed q, or invalid target_url/cadence.
403
webhook_tier_required or webhook_limit_reached.