Quickstart Guide

curl https://getregime.com/api/v1/market/overview

curl -X POST https://getregime.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]"}'

curl https://getregime.com/api/v1/signals/all \
  -H "Authorization: Bearer YOUR_API_KEY"

GET /api/v1/market/overview

# Returns:
# - BTC & ETH price, 24h change
# - Fear & Greed Index (0-100)
# - BTC Dominance %
# - Total market cap, volume
# - DeFi TVL
# - Regime classification (bull/bear/chop + confidence)
# - 10 regime signals with individual interpretations

curl https://getregime.com/api/v1/market/regime

curl https://getregime.com/api/v1/intelligence/brief \
  -H "Authorization: Bearer YOUR_API_KEY"

# Returns: regime, confidence, top drivers, crowd positioning,
# macro environment (DXY, VIX, SPX, Gold), active signals,
# risk assessment, and actionable summary

curl https://getregime.com/api/v1/intelligence/crowd-positioning \
  -H "Authorization: Bearer YOUR_API_KEY"

# Returns: funding_bias (long/short/neutral),
# avg_funding_rate_btc, long_short_ratio_btc,
# liquidation_imbalance, crowd_direction

curl https://getregime.com/api/v1/intelligence/divergences \
  -H "Authorization: Bearer YOUR_API_KEY"

# Detects: DXY-BTC divergence, VIX-crypto mismatch,
# fear-regime disagreement, extreme fear in bear regime,
# OI-price divergence across assets

curl https://getregime.com/api/v1/intelligence/regime-history \
  -H "Authorization: Bearer YOUR_API_KEY"

# Pro: 30 days of history
# Institutional: full history back to day one

# Pass a Unix timestamp (ms)
curl "https://getregime.com/api/v1/intelligence/regime-at?ts=1774500000000" \
  -H "Authorization: Bearer YOUR_API_KEY"

curl https://getregime.com/api/v1/intelligence/hmm-regime \
  -H "Authorization: Bearer YOUR_API_KEY"

# All signals
curl https://getregime.com/api/v1/signals/all \
  -H "Authorization: Bearer YOUR_API_KEY"

# Signals for a specific asset
curl https://getregime.com/api/v1/signals/ETHUSDT \
  -H "Authorization: Bearer YOUR_API_KEY"

# pip install requests
import requests

BASE = "https://getregime.com"
API_KEY = "YOUR_API_KEY"

# No auth needed for market data
overview = requests.get(f"{BASE}/api/v1/market/overview").json()
print(f"Regime: {overview['regime']['regime']} ({overview['regime']['confidence']:.0%})")
print(f"Fear & Greed: {overview['fearGreedIndex']}")

# Auth required for signals
headers = {"Authorization": f"Bearer {API_KEY}"}
signals = requests.get(f"{BASE}/api/v1/signals/all", headers=headers).json()
for s in signals:
    print(f"  {s['symbol']} — {s['direction']} (strength: {s['strength']})")

// No dependencies needed — uses built-in fetch
const BASE = 'https://getregime.com';
const API_KEY = 'YOUR_API_KEY';

// Market overview (no auth)
const overview = await fetch(`${BASE}/api/v1/market/overview`)
  .then(r => r.json());

console.log(`Regime: ${overview.regime.regime}`);
console.log(`Fear & Greed: ${overview.fearGreedIndex}`);

// Strategy signals (auth required)
const signals = await fetch(`${BASE}/api/v1/signals/all`, {
  headers: { Authorization: `Bearer ${API_KEY}` }
}).then(r => r.json());

signals.forEach(s =>
  console.log(`${s.symbol} — ${s.direction} (${s.strength})`)
);

# Check regime before entering any trade
import requests, time

BASE = "https://getregime.com"
KEY = "YOUR_API_KEY"
headers = {"Authorization": f"Bearer {KEY}"}

while True:
    # 1. Check regime — don't trade in bear markets
    regime = requests.get(f"{BASE}/api/v1/market/regime").json()
    if regime["regime"] == "bear" and regime["confidence"] > 0.7:
        print("Bear market — sitting out")
        time.sleep(300)
        continue

    # 2. Get signals
    signals = requests.get(f"{BASE}/api/v1/signals/all", headers=headers).json()
    bullish = [s for s in signals if s["direction"] == "long"]

    for signal in bullish:
        # 3. Check token risk before entering
        risk = requests.get(
            f"{BASE}/api/v1/risk-score/{signal['token_address']}",
            headers=headers
        ).json()

        if risk["score"] > 70:
            print(f"Skipping {signal['symbol']} — risk score {risk['score']}")
            continue

        print(f"Signal: {signal['symbol']} {signal['direction']} (risk: {risk['score']})")
        # Execute your trade logic here...

    time.sleep(60)