View as markdown
Endpoints

Scan

A universe-wide query: send a SQL WHERE clause, get every ticker that matches.

MethodPathSummary
POSThttps://api.tickerbot.io/v2/scanRun a SQL WHERE against the current universe.
POSThttps://api.tickerbot.io/v2/scanRun a SQL WHERE against any past moment — same endpoint as live, with `asof` set.
POSThttps://api.tickerbot.io/v2/scan/subscribeCreate a webhook that fires when any ticker matches an arbitrary 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 live and as-of endpoints also accept GET with parameters in the query string — handy for short queries and interactive testing.