← tickerbot.io
View as markdown
Getting started

Quickstart

Get your first request running in 60 seconds.

Authenticate

One header on every request. That is the whole auth model for REST.

Authorization: Bearer YOUR_KEY

Get a key from tickerbot.io/dashboard/keys — free, no card — and swap it in for YOUR_KEY in every example below.

Get the state of one ticker

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

Get the state of one signal: every ticker where at_52w_high is true

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

Any name from the catalog goes in the path.

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"
  }'

The same scan, as the market stood in the past — no look-ahead, delisted names included

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",
    "asof": "2026-06-28"
  }'

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-08-17" \
  -H "Authorization: Bearer YOUR_KEY"

Subscribe a query — we POST your URL when a ticker enters the match set

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"
  }'

Next: build something

Seven things people build on the table, each in a handful of calls like the ones above, every step a real request with its captured response.