---
title: "Detected patterns for a symbol"
method: GET
path: "/patterns/{symbol}"
tags: ["Patterns"]
---

# Detected patterns for a symbol

`GET /patterns/{symbol}`

## Request

- Base URL: `https://stockmarketscan.com/api/v1`
- URL: `https://stockmarketscan.com/api/v1/patterns/{symbol}`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer
  - API key in header `X-RapidAPI-Key`

The most recent pattern computation for one symbol. When nothing has
been computed, `patterns` is empty and `computed_at` is null.

## Path parameters

- `symbol` string, required

## Query parameters

- `interval` '1d' | '1wk'

## Headers

- `If-None-Match` string

## Response `200`

Pattern list

- object
  - `data` SymbolPatterns, required
    - `symbol` string, required
    - `interval` '1d' | '1wk', required
    - `computed_at` string, date-time, nullable, required: When the patterns were computed; null when never.
    - `candle_count` integer, nullable, required: Candles the detection ran on.
    - `patterns` Pattern[], required
      - `id` 'double_top' | 'double_bottom' | 'triple_top' | 'triple_bottom' | 'head_shoulders' | 'inv_head_shoulders' | 'round_bottom' | 'cup_handle' | 'asc_triangle' | 'desc_triangle' | 'sym_triangle' | 'channel_up' | 'channel_down' | 'rectangle' | 'flag' | 'wedge_rising' | 'wedge_falling' | 'abcd' | 'gartley' | 'bat' | 'butterfly' | 'crab' | 'impulse_wave' | 'corrective_wave', required
      - `name` string, required
      - `type` 'bullish' | 'bearish' | 'neutral', required: Conventional direction of the chart pattern.
      - `category` 'reversal' | 'continuation' | 'harmonic' | 'wave', required
      - `confidence` number, nullable, required
      - `points` PatternPoint[], required
        - `index` integer, nullable, required: Candle index within the analysed window.
        - `date` string, date, nullable, required
        - `price` number, nullable, required
        - `label` string, nullable, required
      - `lines` PatternLine[], required
        - `points` object[], required
          - `date` string, date, nullable, required
          - `price` number, nullable, required
        - `style` 'solid' | 'dashed' | 'dotted' | 'null', nullable, required
      - `target_price` number, nullable, required: Measured-move price level; null when not defined for the pattern.
      - `last_structural_point` PatternPoint, required
        - `index` integer, nullable, required: Candle index within the analysed window.
        - `date` string, date, nullable, required
        - `price` number, nullable, required
        - `label` string, nullable, required
  - `meta` object, required: Response metadata. Endpoint-specific keys are documented per operation.
    - `as_of` string, date, nullable, required: Trading date of the underlying data. Null when there is no data.
    - `generated_at` string, date-time, required: When this response was produced (RFC 3339 UTC).
    - `pagination` Pagination: Present on list endpoints. Follow `next_cursor` until it is null.
      - `limit` integer, required: Page size that was applied.
      - `next_cursor` string, nullable, required: Cursor for the next page; null on the last page.
      - `total` integer: Rows across all pages. Only where it is cheap and exact.
    - `parameters` object: Parameters applied after defaults.

## Other responses

- `304`: Not modified since the ETag in `If-None-Match`. No body; not counted against your quota.
- `400`: Invalid parameter, cursor or body. Not counted against your quota.
- `401`: Missing or invalid credentials.
- `403`: Your plan does not include this endpoint or screener. Not counted against your quota.
- `429`: Rate limit or quota exceeded. `Retry-After` says when to retry.
- `500`: Unexpected server error. Quote `request_id` when reporting it.
- `503`: A dependency (database or key store) is unavailable.

---

[API](https://skmtc.dev/stockmarketscan/apis/stockmarketscan-api.md) · [All operations](https://skmtc.dev/stockmarketscan/apis/stockmarketscan-api/llms.txt) · [OpenAPI document](https://skmtc.dev/stockmarketscan/apis/stockmarketscan-api/revisions/2cca1387a5fe?raw)