getregime

TypeScript SDK for the Regime crypto market intelligence API.

One API call tells you if the market is bullish, bearish, or chopping — with confidence scores, signal breakdowns, and data from 9 sources.

Quick Start

npm install getregime

import { CseClient } from 'getregime';

const regime = new CseClient(); // No API key needed for basic access

// What's the market doing right now?
const market = await regime.getRegime();
console.log(market.regime);     // "bull" | "bear" | "chop"
console.log(market.confidence); // 0.95

That's it. No API key required for regime classification.

Why Regime?

Most crypto APIs give you raw data. Regime gives you answers:

• Regime Detection — 6-signal classifier: SMA crossover, Fear & Greed, dominance, volume, volatility, DXY
• 9 Data Sources — Binance, CoinGecko, DeFiLlama, FRED, Yahoo Finance, and more
• Intelligence Endpoints — Crowd positioning, macro divergences, market briefs (Pro)
• Strategy Signals — Live signals from 6 backtested strategies (Pro)

Examples

// Market overview — BTC, ETH prices, Fear & Greed, TVL, regime
const overview = await regime.getOverview();

// Asset snapshots — price, volume, funding rates
const assets = await regime.getAssets();

// With Pro API key — unlock everything
const pro = new CseClient({ apiKey: 'cse_pro_your_key_here' });

// Full signal breakdowns
const regime = await pro.getRegime();
console.log(regime.signals); // [{name: "BTC SMA 50/200", interpretation: "bullish"}, ...]

// Intelligence brief — synthesized market analysis
const brief = await pro.getIntelligenceBrief();

// Crowd positioning — funding bias, liquidation imbalance
const crowd = await pro.getCrowdPositioning();

// Macro divergences — DXY-BTC, VIX-crypto, fear-regime
const divergences = await pro.getDivergences();

Pricing

| | Free | Pro ($49/mo) | Institutional ($299/mo) | |---|---|---|---| | Regime classification | 15min delay | Real-time | Real-time | | Assets | BTC, ETH | 20+ | 20+ | | Signal breakdowns | Summary only | Full detail | Full detail | | Intelligence endpoints | - | All | All | | Daily API calls | 500 | 10,000 | Unlimited | | RPM | 10 | 120 | 1,000 | | Historical data | - | - | Full archive |

Get your API key: getregime.com/quickstart

API Reference

| Method | Tier | Description | |--------|------|-------------| | getRegime() | Free | Market regime (bull/bear/chop) + confidence | | getOverview() | Free | BTC, ETH, Fear & Greed, TVL, dominance | | getAssets() | Free | Asset snapshots (price, volume) | | getSignals() | Pro | Strategy signals from 6 live lanes | | getRiskScore(address) | Pro | Token safety score (7 on-chain checks) | | getIntelligenceBrief() | Pro | Synthesized market intelligence | | getCrowdPositioning() | Pro | Funding bias, crowd direction | | getDivergences() | Pro | DXY-BTC, VIX-crypto divergences | | getMacro() | Pro | DXY, VIX, SPX, Gold, Fed data | | getFutures() | Pro | Aggregated funding + liquidations | | getRegimeHistory() | Inst | Historical regime transitions |

Links

• API Docs
• OpenAPI Spec
• Website

License

MIT