View as markdown
Endpoints

All endpoints

The API surface at a glance — one schema, one SQL grammar. The exhaustive machine-readable contract, including utility endpoints, is the OpenAPI spec.

Tickers

One ticker, one moment: current state, point-in-time snapshot, ETF composition.

MethodPathSummary
GEThttps://api.tickerbot.io/v2/tickersThe symbol directory: every tracked ticker, alphabetical, paginated.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}Get the full current state of one ticker.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}?asof=The full ticker row as it stood at a past moment.
POSThttps://api.tickerbot.io/v2/tickers/{ticker}/subscribeCreate a webhook that fires when this ticker matches a query.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}/coverageWhat data exists for a ticker — spans per resolution + measured per-field depth.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}/holdingsConstituent holdings of an ETF, weight-ranked.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}/sectorsSector allocation of an ETF, weight-ranked.

Tickers reference →

Signals

What signals exist and who matches one right now (or at a past moment).

MethodPathSummary
GEThttps://api.tickerbot.io/v2/signalsBuilt-in signals plus your custom signals, each tagged with `kind`.
GEThttps://api.tickerbot.io/v2/signals/{signal}Find the tickers where a signal is true right now.
GEThttps://api.tickerbot.io/v2/signals/{signal}?asof=Run the match set at any past moment — same endpoint as live, with ?asof=.
POSThttps://api.tickerbot.io/v2/signals/{signal}/subscribeCreate a webhook that fires when any ticker matches this signal.

Signals reference →

Scan

Many tickers, one moment — a SQL WHERE across the live universe or a past instant.

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.

Scan reference →

Series

Ticker state over time on one aligned grid — any columns, any tickers, plus the chart feed.

MethodPathSummary
GEThttps://api.tickerbot.io/v2/seriesAny columns for any tickers on one aligned time grid — the canonical series read.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}/bars/{interval}The chart feed: OHLCV bars in a compact array shape, down to 1-second.

Series reference →

Events

Discrete things that happened — one cross-ticker timeline, one row per kind, plus the spans shape.

MethodPathSummary
GEThttps://api.tickerbot.io/v2/eventsOne timeline over every event log: dividends, splits, insider transactions, analyst actions — plus opt-in signal firings and news.
POSThttps://api.tickerbot.io/v2/events/subscribeWebhook on new dividends, splits, insider filings, or analyst actions.
GEThttps://api.tickerbot.io/v2/events?kind=dividendCash-dividend declarations on the unified timeline; doubles as a dividend calendar.
GEThttps://api.tickerbot.io/v2/events?kind=splitStock splits and reverse splits, timestamped at the execution date.
GEThttps://api.tickerbot.io/v2/events?kind=insiderOfficer and director trades (Form 4 activity).
GEThttps://api.tickerbot.io/v2/events?kind=analystUpgrades, downgrades, initiations, and price-target changes; hourly, 24/7.
GEThttps://api.tickerbot.io/v2/events?kind=newsHeadlines as events on the timeline (opt-in); /v2/news stays the search surface.
GEThttps://api.tickerbot.io/v2/events?kind=signalBoolean-flag flips as enter/exit point-events (opt-in).
GEThttps://api.tickerbot.io/v2/signals/{signal}/{ticker}/eventsRun-length-encoded occurrences — windows for state flags, points for event flags.

Events reference →

News

SQL query over the news archive: article rows or rollups by ticker, day, source, or sentiment.

MethodPathSummary
GEThttps://api.tickerbot.io/v2/newsSQL query over the news_article archive. Returns articles or aggregate rollups.

News reference →

Custom signals

Named boolean predicates you author and reference like a built-in.

MethodPathSummary
POSThttps://api.tickerbot.io/v2/signalsSave a named boolean SQL predicate you can reference like a built-in signal.
PATCHhttps://api.tickerbot.io/v2/signals/{signal}Edit the expression or description of one of your custom signals.
DELETEhttps://api.tickerbot.io/v2/signals/{signal}Remove a custom signal — refused by default if anything references it.

Custom signals reference →

Universes

Named ticker lists you reference from any query endpoint with ?universe=<slug>. Built-in and custom come from one list (?owner=).

MethodPathSummary
POSThttps://api.tickerbot.io/v2/universesCreate a universe.
GEThttps://api.tickerbot.io/v2/universes/{id}Fetch a single universe.
GEThttps://api.tickerbot.io/v2/universesGet all universes — yours, the built-in system ones, or both.
PATCHhttps://api.tickerbot.io/v2/universes/{id}Update a universe.
DELETEhttps://api.tickerbot.io/v2/universes/{id}Delete a universe.

Universes reference →

Webhooks

A trigger plus a delivery. POST /v2/webhooks is canonical; the /subscribe shortcuts build the identical webhook.

MethodPathSummary
POSThttps://api.tickerbot.io/v2/webhooksCanonical create: a webhook is a trigger plus a delivery.
GEThttps://api.tickerbot.io/v2/webhooks/{id}Fetch one webhook subscription.
GEThttps://api.tickerbot.io/v2/webhooksList every webhook subscription on this account.
PATCHhttps://api.tickerbot.io/v2/webhooks/{id}Edit a webhook subscription in place.
DELETEhttps://api.tickerbot.io/v2/webhooks/{id}Delete a webhook subscription.
POSThttps://api.tickerbot.io/v2/webhooks/{id}/enableRe-enable a disabled webhook.
POSThttps://api.tickerbot.io/v2/webhooks/{id}/testSend a real-shape test POST to your endpoint, instantly.
GEThttps://api.tickerbot.io/v2/webhooks/{id}/deliveriesInspect recent deliveries for a webhook.

Webhooks reference →

Websockets

Real-time ticker updates over a websocket, plus your stream usage.

MethodPathSummary
WSShttps://api.tickerbot.io/v2/streamHold a socket open and receive each subscribed ticker's freshly-computed row on every refresh.
GEThttps://api.tickerbot.io/v2/stream/usageCurrent WebSocket streaming consumption vs your account cap.

Websockets reference →