# Crypto Donchian Breakout Screener API
> Which coins are breaking out of their recent trading range, computed live from Binance candles — no key, nothing stored. The Donchian channel is the highest high and lowest low of the last N periods; a price above the upper band is a classic trend-following breakout (the original turtle-trading signal) and a price below the lower band a breakdown. The breakout endpoint returns, for one pair, the N-day Donchian upper and lower bands, the current price, where it sits in the channel (0% at the low, 100% at the high), the distance to each band and a status — new_high, new_low, near_high, near_low or inside. The screener endpoint scans a basket of coins and surfaces the ones currently breaking to new highs (momentum-long candidates) and to new lows (breakdowns), ranked by how decisively they have cleared the band. The symbols endpoint lists tradable pairs. This is the range-breakout / Donchian-screener cut for crypto — distinct from the generic indicator calculators (which you feed your own data), the volume-profile, the seasonality and the order-flow APIs in the catalogue. Bands use the prior completed candles, so a breakout is a genuine move beyond the established range. Pairs are Binance symbols (BTCUSDT) or a coin=BTC&quote=USDT form; lookback is 5-200 days.

## Authentication
All requests require your oanor API key in the `x-oanor-key` header. Get one at https://www.oanor.com/developer/keys.

```bash
curl -H "x-oanor-key: oanor_live_…" "https://api.oanor.com/cryptobreakout-api/..."
```

## Pricing
- **Free** (Free) — 400 calls/Mo, 2 req/s
- **Starter** ($11/Mo) — 12,200 calls/Mo, 6 req/s
- **Pro** ($35/Mo) — 71,000 calls/Mo, 16 req/s
- **Business** ($80/Mo) — 365,000 calls/Mo, 40 req/s

## Endpoints

### Breakout

#### `GET /v1/breakout` — One pair's Donchian channel & breakout status

**Parameters:**
- `symbol` (query, required, string) — Binance pair Example: `BTCUSDT`
- `lookback` (query, optional, string) — Channel length in days (5-200, default 20) Example: `20`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/cryptobreakout-api/v1/breakout?symbol=BTCUSDT&lookback=20"
```

#### `GET /v1/screener` — Scan a basket for breakouts & breakdowns

**Parameters:**
- `coins` (query, optional, string) — Comma list of coins (default liquid majors) Example: `BTC,ETH,SOL,DOGE,XRP`
- `lookback` (query, optional, string) — Channel length in days (5-200, default 20) Example: `20`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/cryptobreakout-api/v1/screener?coins=BTC%2CETH%2CSOL%2CDOGE%2CXRP&lookback=20"
```

#### `GET /v1/symbols` — Tradable Binance pairs

**Parameters:**
- `quote` (query, optional, string) — Filter by quote asset Example: `USDT`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/cryptobreakout-api/v1/symbols?quote=USDT"
```

### Meta

#### `GET /v1/meta` — Spec

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/cryptobreakout-api/v1/meta"
```


---
Marketplace page: https://www.oanor.com/api/cryptobreakout-api
OpenAPI spec: https://www.oanor.com/api/cryptobreakout-api/openapi.json