> ## 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. # CLAUDE # CLAUDE.md CryptoQuant API documentation, built with **Mintlify**. Config: `docs.json`. Pages are `.mdx`; API reference is generated from OpenAPI specs. ## Tab → source map | Tab | Rendered from | | - | - | | API v1 | `openapi/v1.json` (Mintlify OpenAPI, `directory: api-reference`) — \~243 endpoints | | API v2 | `v2/*.mdx` pages; each `v2/community/*.mdx` pulls its reference from `openapi/v2.json` via frontmatter `openapi: "openapi/v2.json GET /community/..."` | | Indicator API | hand-written `indicator-api/*.mdx` (Alpha product, host `alpha.cryptoquant.com`) | | Sentiment Data | `sentiment/*.mdx` (Analyst Consensus API, host `consensus.cryptoquant.com`); endpoint pages pull their reference from `openapi/sentiment.json` via frontmatter `openapi: "openapi/sentiment.json GET /..."`. That JSON is a **snapshot imported by `scripts/import-sentiment-openapi.mjs`** from the consensus app's live `/openapi.json` — never hand-edit it; re-run the script (it adds the `x-codeSamples` + MDX escaping) | | Data Guide / Data Catalog / Get Started | hand-written `.mdx` | ## Sentiment Data tab (Analyst Consensus API) — what is different * **Different host, different key.** Base URL `https://consensus.cryptoquant.com/api/v1/`, auth is `X-API-Key: ` (or `?api_key=`), **not** `Authorization: Bearer`. The CryptoQuant Data API key is not accepted there today — do not document it as if it were. Keep the plan rules (No key / Free / Premium / Enterprise, Integration raw-text clearance) as the live API states them; the daily-index-only route with a CryptoQuant key is `indicator-api/consensus`. * **Spec is generated upstream** (unbias-app `web/src/lib/openapi.ts`). Content changes to parameters / schemas / examples belong there; here, `node scripts/import-sentiment-openapi.mjs` refreshes `openapi/sentiment.json` (idempotent; add `--from ` for a local build). Prose on the `sentiment/*.mdx` pages mirrors the former `consensus.cryptoquant.com/docs/api` page — the consensus site now redirects that URL to `/sentiment/overview`, so page slugs under `sentiment/` are external links: rename only with a `redirects` entry in `docs.json`. * Code samples: same five languages and `` placeholder as the other specs, but the header is `X-API-Key`; public (`security: []`) operations carry no header at all. ## MDX rendering gotchas (these break the build silently) Mintlify compiles descriptions and page bodies as MDX. A raw `<...>` that isn't a real component is parsed as JSX; compilation fails and the **entire block renders as raw text** (literal `###`, `|` tables, backticks). Rules: * **Self-close void tags**: `
`, not `
`. Same for `
`, ``. Bare `
` was the cause of the Lightning/Mempool "broken page" reports. * **No raw angle-bracket placeholders in prose or frontmatter**: ``, ``, `List` etc. break MDX unless they are inside a code span (`` `` ``), a code fence, or written as the entity `<`. Frontmatter `description:` is compiled too — it must not contain a raw `<...>`. * Inside fenced/inline code, `<...>` and `{...}` are safe. `{/* ... */}` is a valid MDX comment. `$$ ... \frac{}{} ... $$` is KaTeX, not JSX — leave it. Quick scan for bare void tags: `grep -n '
' openapi/*.json` (expect 0; only `
`). ## Code-sample conventions (keep all three APIs identical) Every `x-codeSamples` / hand-written example uses the **same shape** and the placeholder token **``** (never `${access_token}`, `{access_token}`, `$CRYPTOQUANT_API_KEY`). * **Shell**: `curl -X GET "URL" \` newline `-H "Authorization: Bearer "` (`-X GET` is explicit even though GET is curl's default; public/no-auth endpoints omit the `-H`). * **JavaScript / NodeJS / Ruby / Python**: match the templates already in `openapi/v2.json` (auth header included, ``). Language order: Shell, JavaScript, NodeJS, Ruby, Python. Auth is required on every authenticated example — do not ship a bare `curl "URL"` for a protected endpoint. ## `limit` parameter (differs by API — do not copy blindly) | API | default | min | max | | - | - | - | - | | v1 | 100 | 1 | 100000 | | v2 | 100 | 1 | 10000 | | Indicator API (equities) | — | 1 | 10000 | Exception: `/btc/flow-indicator/stablecoins-ratio` (v1) caps `limit` at 1000, not 100000 — intentional. ## Editing the OpenAPI JSON specs **`openapi/v1.json` is a GENERATED file — never edit it directly.** The nightly `refresh-latency` workflow runs `node scripts/generate-catalog.mjs`, which rebuilds it from `scripts/v1.raw` and commits the result: any direct edit to `openapi/v1.json` (also `catalog/*`, `legacy-redirect-map.json`) is silently reverted within a day. This is exactly how the Lightning-rename, `
`, code-sample, and real-example fixes were all lost once. Instead: * **Content changes** (descriptions, examples, code samples, parameters) → edit `scripts/v1.raw`, then run `node scripts/generate-catalog.mjs` and commit raw + outputs. * **Systematic corrections** (renames, MDX escaping) → add a transform in `scripts/generate-catalog.mjs` (see the "Known content corrections" section: Lightning rename, bare-`
` self-closing). * Keyless runs of the generator keep the cached latency snapshot; only CI (with `CRYPTOQUANT_API_KEY`) refreshes it. The generator is idempotent — re-running must produce no diff. `openapi/v2.json` is still hand-maintained; it is serialized with `json.dumps(data, indent=1, ensure_ascii=False)` and re-dumping is byte-exact. Prefer surgical string replacement for small edits to keep diffs minimal. ## Verifying changes locally ```bash theme={null} npx -y mint@latest dev --port 3111 # http://localhost:3111 ``` `.mdx` edits hot-reload. **Changes to `openapi/*.json` require restarting the dev server** (the parsed spec is cached). Confirm a page renders with 0 console errors before claiming done. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.