> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cryptoquant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Indicator API Overview

> The Alpha Library indicator set, organized by asset class — Bitcoin on-chain/technical signals and computed Korean equity fundamentals.

The Indicator API documents the **Alpha Library** — the indicator set behind the
[alpha.cryptoquant.com](https://alpha.cryptoquant.com) heatmap. Indicators are organized by
asset class, and each one is sourced one of three ways depending on the asset.

## Indicators by asset class

| Asset class          | Indicators                                                       | Source                                                                                                                                            | Reference                                                                                        |
| -------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| **Crypto (Bitcoin)** | On-chain valuation & demand, technical, and analyst consensus    | Core CryptoQuant Data API (`api.cryptoquant.com`), in-app technical formulas, and the Alpha consensus API (`alpha.cryptoquant.com/api/consensus`) | [Crypto Indicators](/indicator-api/crypto) · [Analyst Consensus Index](/indicator-api/consensus) |
| **Equities (KRX)**   | Computed fundamentals from DART filings, prices, and market data | Alpha equities API (`alpha.cryptoquant.com/api/equities`)                                                                                         | [KRX Equities](/indicator-api/equities)                                                          |

Every indicator is z-scored over a trailing multi-year window before it is colored on the heatmap
(green = bull/buy regime, red = bear/sell regime).

## Alpha API surface

The Alpha equities indicators and the Analyst Consensus Index are served from a dedicated host:

```text theme={null}
https://alpha.cryptoquant.com/api
```

Unlike the core CryptoQuant Data API, these endpoints are productized indicators,
not raw source-data feeds.

### Endpoint structure

```text theme={null}
https://alpha.cryptoquant.com/api

├── /consensus
│   └── /{asset}
├── /equities
│   ├── /{asset}
│   └── /{asset}/{metric}
└── /indicators
```

| Endpoint                             | Access          | Purpose                                                                     |
| ------------------------------------ | --------------- | --------------------------------------------------------------------------- |
| `GET /api`                           | Public          | Top-level Alpha API catalog                                                 |
| `GET /api/consensus`                 | Public          | Analyst Consensus Index catalog: assets, metric metadata, field definitions |
| `GET /api/consensus/{asset}`         | Premium API key | Daily Analyst Consensus Index series for one asset (BTC, ETH, SOL)          |
| `GET /api/equities`                  | Public          | Equity asset catalog, metric catalog, identifier policy, and data policy    |
| `GET /api/equities/{asset}`          | Pro+ API key    | All computed indicator series for one KRX equity                            |
| `GET /api/equities/{asset}/{metric}` | Pro+ API key    | One computed indicator series for one KRX equity                            |
| `GET /api/indicators`                | Public          | Metadata-only Alpha Library indicator catalog (all asset classes)           |

<Note>
  Bitcoin on-chain indicators are served by the **core CryptoQuant Data API**
  (`api.cryptoquant.com`), not the Alpha host. See [Crypto Indicators](/indicator-api/crypto) for the
  endpoint behind each signal. The one crypto series on the Alpha host is the
  [Analyst Consensus Index](/indicator-api/consensus), which requires the **Premium plan**.
</Note>

## Data policy

<Note>
  DART/OpenDART source filing rows are not redistributed. Equity endpoints expose only
  computed indicators derived from filings, prices, and market data.
</Note>

Each equity metric is marked with:

```json theme={null}
{
  "source": "dart-computed",
  "sourcePolicy": "dart-computed",
  "rawRedistribution": false
}
```

## Relationship to API v1 and API v2

| API surface   | Host                        | Scope                                                                             |
| ------------- | --------------------------- | --------------------------------------------------------------------------------- |
| Core API v1   | `api.cryptoquant.com/v1`    | Raw on-chain, market, and flow data                                               |
| Core API v2   | `api.cryptoquant.com/v2`    | Curated crypto research indicators                                                |
| Indicator API | `alpha.cryptoquant.com/api` | Alpha product indicators: KRX equity fundamentals and the Analyst Consensus Index |

The response envelope intentionally follows the same `status` / `result` pattern used by
the core CryptoQuant APIs.