Endpoints › Scan
Scan
The whole market through one SQL WHERE clause. Live, as of any past date, or as a subscription.
| Method | Path | Summary |
|---|---|---|
| POST | https://api.tickerbot.io/ | Run a SQL WHERE against the current universe. |
| POST | https://api.tickerbot.io/ | Create a webhook that fires when a ticker matches a WHERE clause. |
Three tenses, one clause
The same q reads live, reads the past, or pushes.
Send q in a JSON body and the server returns every ticker matching right now. Add asof — a YYYY-MM-DD date for that day’s close, or a full ISO timestamp for any intraday moment — and the same clause evaluates against the past, with the serving tier reported in _meta.interval. Subscribe that clause as a webhook and we push you each time a new ticker enters the match set.
universe is a scoping shortcut on every form. The state read also accepts GET with parameters in the query string, handy for short queries and interactive testing.