← tickerbot.io
View as markdown
Endpoints

All endpoints

Every page of the reference, by family, in the rail’s order. The story of what each family is for is on the Introduction; the exhaustive machine-readable contract, including utility endpoints, is the OpenAPI spec.

Tickers

MethodPathSummary
GEThttps://api.tickerbot.io/v2/tickersThe catalog: every tracked symbol with its identity, alphabetical and paginated.
GEThttps://api.tickerbot.io/v2/tickers/{ticker}The full current state of one ticker, or up to 50 at once with the list in the path.
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}/coverageHow much data a ticker has. Spans per resolution, measured depth per signal.

Signals

MethodPathSummary
GEThttps://api.tickerbot.io/v2/signalsBuilt-in signals plus your custom signals, each tagged with `kind`.
GEThttps://api.tickerbot.io/v2/signals/{signal}Every ticker matching a signal right now.
POSThttps://api.tickerbot.io/v2/signals/{signal}/subscribeCreate a webhook that fires when any ticker matches this signal.
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.

Scan

MethodPathSummary
POSThttps://api.tickerbot.io/v2/scanRun a SQL WHERE against the current universe.
POSThttps://api.tickerbot.io/v2/scan/subscribeCreate a webhook that fires when a ticker matches a WHERE clause.

Series

MethodPathSummary
GEThttps://api.tickerbot.io/v2/seriesAny signals for any tickers on one aligned time grid.

Bars

MethodPathSummary
GEThttps://api.tickerbot.io/v2/bars/{ticker}/{interval}OHLCV bars from 1-second to monthly, in a compact array shape.

Events

MethodPathSummary
GEThttps://api.tickerbot.io/v2/eventsOne timeline over every event log: earnings, dividends, splits, insider transactions, analyst actions, plus opt-in signal firings and news.
GEThttps://api.tickerbot.io/v2/events?kind=earningsQuarterly earnings reports, timestamped at the report date. Reported vs estimated EPS and the surprise.
GEThttps://api.tickerbot.io/v2/events?kind=dividendCash-dividend declarations. 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, opt-in. /v2/news is the search surface.
GEThttps://api.tickerbot.io/v2/events?kind=signalBoolean flips as enter/exit point-events, opt-in.
POSThttps://api.tickerbot.io/v2/events/subscribeWebhook on new earnings, dividends, splits, insider filings, or analyst actions.

News

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

ETF

MethodPathSummary
GEThttps://api.tickerbot.io/v2/etf/{ticker}/holdingsConstituent holdings of an ETF, weight-ranked.
GEThttps://api.tickerbot.io/v2/etf/{ticker}/sectorsSector allocation of an ETF, weight-ranked.

Universes

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.
GEThttps://api.tickerbot.io/v2/universes/systemList system universes (top_10, top_100).
PATCHhttps://api.tickerbot.io/v2/universes/{id}Update a universe.
DELETEhttps://api.tickerbot.io/v2/universes/{id}Delete a universe.

Webhooks

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.

Websockets

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.