---
title: "Correlation vs Benchmark (CORREL)"
method: GET
path: "/api/v1/indicators/correl"
tags: ["Technical Indicators"]
---

# Correlation vs Benchmark (CORREL)

`GET /api/v1/indicators/correl`

Rolling Pearson correlation of `symbol` log-returns vs `benchmark` (default SPY) log-returns over `time_period` bars. Range -1..+1. Useful for diversification analysis and pairs-trading screen.

## Query parameters

- `symbol` string, required
- `benchmark` string — Benchmark ticker; default SPY (S&P 500 ETF).
- `time_period` string, required
- `interval` string
- `range` string, nullable
- `outputsize` integer

## Response `200`

Successful Response

- EnvelopeIndicatorsBetaData
  - `data` IndicatorsBetaData, required
    - `symbol` string, nullable
    - `indicator` string, nullable
    - `interval` string, nullable
    - `outputsize` union
      - integer
      - number
    - `time_period` union[], nullable
      - union
        - integer
        - number
    - `series_by_period` object, nullable
    - `source` string, nullable
    - `benchmark` string, nullable
  - `meta` SugraMeta, required — Metadata attached to every /api/v1/* response envelope.
    - `endpoint` string, required — Requested endpoint path.
    - `data_time` string, required — ISO 8601 UTC timestamp of the source data, not of the request.
    - `response_time` string, required — ISO 8601 UTC timestamp when this response was produced.
    - `provider` string, required — API name and version.
    - `source` string, nullable — Identifier of the primary upstream source used for this response.
    - `attribution` string, nullable — Human-readable attribution mandated by an upstream source (e.g. a securities regulator or self-regulatory organization). Present only on responses whose source requires the owner and source to be clearly identified. Do not remove or alter it when using the response.
    - `fallback_used` boolean, nullable — True when the primary source failed and a fallback produced the data.
    - `fallback_chain` string[], nullable — Ordered list of sources attempted, in the order they were tried.
    - `cached` boolean, nullable — True when this response was served from the internal cache.
    - `stale` boolean, nullable — True when the cached response was returned after the upstream rate-limited or errored. Clients can use this to detect degraded data.

## Other responses

- `401` — Missing or invalid `x-api-key` header. JSON body with a stable `code` distinguishing `missing_api_key` (no header sent) from `invalid_api_key` (header sent, key not accepted); any other 401 source carries the generic `unauthorized` with its detail as `reason`. Plus `hint`. `plan` is always null on 401 - an unauthenticated request has no plan; quota exhaustion is 429, not 401.
- `422` — Validation Error
- `429` — Daily rate limit exceeded. Check `X-RateLimit-Reset` for the next window.
- `503` — Upstream source is temporarily unavailable. Retry after a short delay.

## Changes

- **2026-08-28** `560e8847c7b3` — 1 breaking
  - response property `data/time_period/anyOf[subschema #1]/items/` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
- **2026-08-22** `914af3d38c7c` — 1 breaking, 2 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - added the required property `data` to the response with the `200` status
  - added the required property `meta` to the response with the `200` status
- **2026-08-08** `4c4530760ba1` — 12 info
  - added the optional property `code` to the response with the `401` status
  - added the optional property `code` to the response with the `429` status
  - added the optional property `code` to the response with the `503` status
  - added the optional property `hint` to the response with the `401` status
  - …8 more

[Change history](https://skmtc.dev/sugra/apis/sugra-api/changes/api/v1/indicators/correl/get.md)

---

[API](https://skmtc.dev/sugra/apis/sugra-api.md) · [All operations](https://skmtc.dev/sugra/apis/sugra-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sugra/sugra-api/revisions/87582f2e0110/schema)