---
title: "Get Quant Regimes"
method: GET
path: "/api/v1/quant/regimes"
tags: ["Quant"]
---

# Get Quant Regimes

`GET /api/v1/quant/regimes`

## Request

- Base URL: `https://cryptodataapi.com`
- URL: `https://cryptodataapi.com/api/v1/quant/regimes`
- Auth: API key in header `X-API-Key`

The 6-regime taxonomy reference (any valid key).

Stable vocabulary for all quant endpoints: id, label, display name,
description and the suggested algo-basket stance per regime. Raw HMM
states map many-to-one onto these labels; the labels are the API contract.
`catalog_version` is the versioned guarantee behind that: unchanged means
every `id` still maps to the same `label` you can see here — safe to pin
`regime.id` directly rather than re-resolving `label` each call.

## Response `200`

Successful Response

- QuantRegimesResponse
  - `regimes` QuantRegimeInfo[], required
    - `id` integer, required
    - `label` string, required
    - `name` string, required
    - `description` string, required
    - `stance` string, required
    - `color` string, required
  - `count` integer, required
  - `catalog_version` string, required: CalVer of this id<->label mapping. The mapping is a stable, versioned contract — relabeling an existing id or reordering ids only happens alongside a bump here (and a CHANGELOG entry). Safe to key off `regime.id` directly as long as this version is unchanged; appending a new id at the end does not bump it.

---

[API](https://skmtc.dev/cryptodataapi/apis/crypto-data-api.md) · [All operations](https://skmtc.dev/cryptodataapi/apis/crypto-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cryptodataapi/apis/crypto-data-api/revisions/8628b754ca81?raw)
