View as markdown
Getting started

Quickstart

Get your first request running in 60 seconds. Authenticate with a bearer token; everything else is shaped like a normal REST call.

60-second quickstart

Six calls that cover most of what the API does. Swap YOUR_KEY for the value from /dashboard/keys.

Get the current state of one ticker

curl "https://api.tickerbot.io/v2/tickers/AAPL" \
  -H "Authorization: Bearer YOUR_KEY"

Get the current state of one signal

curl "https://api.tickerbot.io/v2/signals/at_52w_high" \
  -H "Authorization: Bearer YOUR_KEY"

Find every large cap trading above its 200-day average

curl -X POST "https://api.tickerbot.io/v2/scan" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "q": "above_sma_200 AND market_cap > 1e10"
  }'

Pull two tickers' price and RSI on one aligned timeline

curl "https://api.tickerbot.io/v2/series?tickers=AAPL%2CMSFT&columns=close%2Crsi_14" \
  -H "Authorization: Bearer YOUR_KEY"

Every analyst action on a ticker this month, as events

curl "https://api.tickerbot.io/v2/events?ticker=AAPL&kind=analyst&from=2026-07-03" \
  -H "Authorization: Bearer YOUR_KEY"

Subscribe a query — we POST your URL on every match

curl -X POST "https://api.tickerbot.io/v2/webhooks" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trigger": {
      "type": "scan",
      "q": "at_20d_high AND small_cap"
    },
    "target_url": "https://yourapp.com/hooks/breakouts",
    "name": "small-cap breakouts"
  }'