Endpoints
Scan
A universe-wide query. Send a SQL WHERE clause as q in a JSON body; the server returns every ticker that matches right now, or include asof: "YYYY-MM-DD" to evaluate the same clause against a past trading day. Accepts universe as a scoping shortcut. Subscribe the same q via POST /v2/scan/subscribe and we POST your endpoint each time a new ticker enters the match set. The live and as-of scan endpoints also accept GET with parameters in the query string — handy for short queries and interactive testing. /v2/scan/subscribe is POST only.
| Method | Path | Summary |
|---|---|---|
| POST | https://api.tickerbot.io/v2/scan | Run a SQL WHERE against the current universe. |
| POST | https://api.tickerbot.io/v2/scan | Run a SQL WHERE against the close of a past trading day — same endpoint as live, with `asof` set. |
| POST | https://api.tickerbot.io/v2/scan/subscribe | Create a webhook that fires when any ticker matches an arbitrary WHERE clause. |