# Tickerbot API — 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

Swap `YOUR_KEY` for the value from https://tickerbot.io/dashboard/keys.

```shell
# 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 small cap gapping up on volume
curl "https://api.tickerbot.io/v2/scan?q=gap_up AND small_cap AND high_volume_alert" \
  -H "Authorization: Bearer YOUR_KEY"

# Subscribe a query — we POST your URL when a new ticker enters the match set
curl -X POST "https://api.tickerbot.io/v2/scan/subscribe" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "small-cap breakouts",
    "q": "breakout AND small_cap",
    "target_url": "https://yourapp.com/hooks/breakouts"
  }'
```