# 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"
```

**Response:**
```json
{
    "data": {
        "note": "Candlestick patterns detected on each market's most recent daily candle. A bullish pattern (hammer, bullish engulfing, etc.) hints up; a bearish one (shooting star, bearish engulfing) hints down; doji is indecision. Patterns are price-action signals, strongest at trend extremes — confirm before trading.",
        "class": "commodities",
        "assets": [
            {
                "key": "gold",
                "class": "commodities",
                "label": "Gold",
                "candle": {
                    "low": 371.88,
                    "high": 387.21,
                    "open": 373.96,
                    "close": 386.32,
                    "color": "green"
                },
                "signal": "bullish",
                "patterns": [
                    {
                        "bias": "bullish",
                        "pattern": "bullish_engulfing"
                    }
                ]
            },
            {
                "key": "silver",
                "class": "commodities",
                "label": "Silver",
                "candle": {
                    "low": 57.3,
                    "high": 61.1,
                    "open": 57.45,
                    "close": 60.82,
                    "color": "green"
                },
                "signal": "bullish",
                "patterns": [
                    {
                        "bias": "bullish",
                        "pattern": "bullis
…(truncated, see openapi.json for full schema)
```

### 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"
```

**Response:**
```json
{
    "data": {
        "key": "sp500",
        "note": "The latest daily candle (open/high/low/close) and any candlestick patterns detected on it, each tagged bullish, bearish or neutral.",
        "class": "equities",
        "label": "S&P 500",
        "candle": {
            "low": 724.41,
            "high": 740,
            "open": 728.76,
            "close": 737.76,
            "color": "green"
        },
        "signal": "none",
        "source": "Yahoo Finance",
        "symbol": "SPY",
        "patterns": []
    },
    "meta": {
        "timestamp": "2026-06-12T10:35:04.202Z",
        "request_id": "2d1da146-62c1-4d79-b85a-170f3d7baffb"
    },
    "status": "ok",
    "message": "Asset retrieved successfully",
    "success": true
}
```

### Patterns

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

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

**Response:**
```json
{
    "data": {
        "note": "Recognised single- and two-candle patterns with their directional bias.",
        "count": 11,
        "source": "Yahoo Finance",
        "patterns": [
            {
                "bias": "neutral",
                "name": "doji"
            },
            {
                "bias": "bullish",
                "name": "hammer"
            },
            {
                "bias": "bullish",
                "name": "inverted_hammer"
            },
            {
                "bias": "bearish",
                "name": "hanging_man"
            },
            {
                "bias": "bearish",
                "name": "shooting_star"
            },
            {
                "bias": "bullish",
                "name": "bullish_engulfing"
            },
            {
                "bias": "bearish",
                "name": "bearish_engulfing"
            },
            {
                "bias": "bullish",
                "name": "bullish_harami"
            },
            {
                "bias": "bearish",
                "name": "bearish_harami"
            },
            {
                "bias": "bullish",
                "name": "bullish_marubozu"
            },
            {
                "bias": "bearish",
                "name": "bearish_marubozu"
            }
        ]
    },
    "meta": {
        "timestamp": "2026-06-12T10:35:04.311Z",
        "request_id": "a5f29d72-9bc0-427b-9293-f9a20bcf8be0"
    },
    "status": "ok",
    
…(truncated, see openapi.json for full schema)
```

### Meta

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

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

**Response:**
```json
{
    "data": {
        "note": "screener class= filters by class. asset= is a supported key (see /v1/universe). Patterns are detected on the most recent completed daily candle. Read fresh per call, nothing cached.",
        "source": "Yahoo Finance daily OHLC (3mo range) across a multi-asset universe, live",
        "classes": [
            "equities",
            "sector",
            "commodities",
            "bonds",
            "crypto"
        ],
        "service": "candlestickscreener-api",
        "endpoints": {
            "GET /v1/meta": "This document.",
            "GET /v1/asset": "One market's latest candle and detected patterns (asset=sp500).",
            "GET /v1/patterns": "The recognised candlestick patterns.",
            "GET /v1/screener": "Cross-asset board of markets flashing a candlestick pattern, split bullish/bearish (class=sector optional)."
        },
        "description": "Candlestick pattern screener (multi-asset) — which markets just printed a reversal or continuation candlestick pattern on their latest daily candle, live from Yahoo Finance (no key, nothing stored). screener returns every market flashing a pattern now, split into bullish and bearish signals. asset returns one market's latest candle with detected patterns. patterns 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.",
        "universe_size": 21,
        "asse
…(truncated, see openapi.json for full schema)
```


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