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 `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.

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