# Candlestick Pattern Screener (Multi-Asset) API
> Which markets just printed a reversal or continuation candlestick pattern on their latest daily candle, computed live from Yahoo Finance (no key, nothing stored). Candlestick patterns are the oldest price-action signals there are: a hammer at a low hints a bounce, a shooting star at a high a turn, an engulfing candle a momentum shift. For a cross-asset, cross-sector universe — equity indices and sectors, gold, oil, commodities, bonds and crypto — this reads each asset's most recent candles and detects the classic single- and two-candle patterns (doji, hammer, inverted hammer, shooting star, hanging man, bullish/bearish engulfing, bullish/bearish harami, marubozu), tagging each bullish, bearish or neutral. The screener endpoint returns every market flashing a pattern right now, split into bullish and bearish signals. The asset endpoint returns one market's latest candle with any pattern detected on it. The patterns endpoint lists what is recognised. The cross-asset candlestick-pattern screener cut — distinct from the crypto-only pattern detector and the bring-your-own-candle pattern API. It scans the whole market for price-action signals at once.

## 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/candlestickscreener-api/..."
```

## Pricing
- **Free** (Free) — 800 calls/Mo, 2 req/s
- **Starter** ($12/Mo) — 17,800 calls/Mo, 6 req/s
- **Pro** ($35/Mo) — 90,000 calls/Mo, 16 req/s
- **Business** ($81/Mo) — 488,000 calls/Mo, 40 req/s

## Endpoints

### Screener

#### `GET /v1/screener` — Cross-asset board of markets flashing a candlestick pattern, split bullish/bearish

**Parameters:**
- `class` (query, optional, string) — Filter by class: equities, sector, commodities, bonds, crypto Example: `commodities`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/candlestickscreener-api/v1/screener?class=commodities"
```

### Asset

#### `GET /v1/asset` — One market latest candle and detected patterns

**Parameters:**
- `asset` (query, required, string) — Asset key (see /v1/universe) Example: `sp500`

**Example:**
```bash
curl -H "x-oanor-key: $KEY" \
  "https://api.oanor.com/candlestickscreener-api/v1/asset?asset=sp500"
```

### Patterns

#### `GET /v1/patterns` — Recognised candlestick patterns

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

### Meta

#### `GET /v1/meta` — Service metadata

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


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