Setup

API keys, demo mode and a setup prompt for your AI agent
BTC dominance
—
—
Stablecoin mcap
—
—
HL 24h volume
—
—
BTC OI · all venues
—
—
HL open interest
—
—
24h liquidations
—
—
L/S ratio
—
—
Whale short share
—
—
Fear & greed
—
—

Set up live data

The dashboard runs with no keys at all: every panel then shows saved responses (demo mode). Two keys switch it to live data. Both live only in the repo-root .env and are read by the worker; the browser never sees them. This page is part of the static demo, so clone the repo (GitHub) to run it yourself.

CryptoDataApi key (required for live data)

Static demo
Environment variable: CDA_API_KEY

Every market panel, the KPI tiles and the live tape come from CryptoDataApi.

A free key comes from POST https://cryptodataapi.com/api/v1/auth/keys with your email (see AI agent guide). Confirming the email turns on Pro for 24 hours. The dashboard is sized for Pro or Pro Plus (pricing).

TypeSafe key (optional)

Static demo
Environment variable: TYPESAFE_API_KEY

Powers the Jev classifier: its read of each news catalyst, the cascade odds on squeeze alerts and the market read in the sidebar.

Create one at console.typesafe.ai. Without it those panels show saved reads. Billing is on input tokens, about 0.3M a day as built.

Set up with your agent

Paste this into your own AI coding agent. It clones the repo, gets the keys with you, starts everything and checks it.

Set up the Crypto Quant Dashboard on this machine for me and report back when it is running.

1. Prerequisites: check for git, Node.js 20.12 or newer (22 recommended), pnpm 10 (run "corepack enable", or "npm i -g pnpm@10" if corepack cannot write to the Node folder) and Docker. Install anything missing or tell me what to install.

2. Get the code:
   git clone https://github.com/Crypto-Data-API/crypto-quant-dashboard.git
   cd crypto-quant-dashboard
   pnpm install
   cp .env.example .env

3. CryptoDataApi key (required for live data). If I do not already have one, ask me for my email address, then create a free key:
   curl -s -X POST https://cryptodataapi.com/api/v1/auth/keys -H "Content-Type: application/json" -d "{\"email\": \"MY_EMAIL\"}"
   The response field "api_key" (starts with cdk_) is shown only once. Write it into .env as CDA_API_KEY=<key>. Tell me to confirm the email CryptoDataApi sends: confirming switches on Pro for 24 hours. Paid Pro and Pro Plus plans are at https://cryptodataapi.com/pricing, and agent docs are at https://cryptodataapi.com/ai-agents.

4. TypeSafe key (optional, powers the Jev classifier panels). Ask me whether I want it. If yes, ask me to create a key at https://console.typesafe.ai/settings/keys and paste it, then write it into .env as TYPESAFE_API_KEY=<key>. If not, leave it empty: those panels show demo data.

5. Never print, log or commit either key. .env is already gitignored.

6. Start Redis: docker compose up -d redis

7. Start the app from the repo root and keep it running: pnpm dev
   (worker on http://localhost:4100, web app on http://localhost:3001)

8. Verify: open http://localhost:3001 and run
   curl -s http://localhost:3001/api/status
   Confirm worker.keyConfigured is true (and jev.configured is true if a TypeSafe key was set). If keyConfigured is false, the worker did not see the key: check that .env is in the repo root, then stop and restart pnpm dev.

9. Report what you did, which keys are configured (without showing them) and the /api/status summary.

Or by hand

git clone https://github.com/Crypto-Data-API/crypto-quant-dashboard.git
cd crypto-quant-dashboard
pnpm install
cp .env.example .env        # then set CDA_API_KEY (and optionally TYPESAFE_API_KEY)
docker compose up -d redis
pnpm dev                    # web http://localhost:3001, worker http://localhost:4100
curl -s http://localhost:3001/api/status   # worker.keyConfigured should be true