Quick Start

Install

# Core only (REST API)
pip install nexus-alpha

# With DataFrame support (recommended)
pip install nexus-alpha[pandas]

# With WebSocket streaming
pip install nexus-alpha[all]

Connect and pull signals

from nexus_alpha import NexusAlpha

client = NexusAlpha("nx_live_your_key_here")
# Or: export NEXUS_ALPHA_API_KEY=nx_live_... then NexusAlpha()

# Top signals right now
for s in client.signals.top(limit=10):
    print(f"{s.ticker:6s} | {s.signal:12s} | conf={s.confidence:.3f} | {s.freshness_status}")
    print(f"  {s.rationale[:80] if s.rationale else ''}")

NVDA   | OVERWEIGHT   | conf=0.712 | LIVE
  GPU demand accelerating; data center revenue beat by 18%
MSFT   | BUY          | conf=0.683 | LIVE
  Azure growth +29% YoY; AI copilot ARR surpassed $5B

Load full history into a DataFrame

# Tier 1: up to 500 rows | Tier 2+: up to 5,000 rows
df = client.signals.history(
    date_from="2024-01-01",
    min_confidence=0.65,
).to_dataframe()

print(df[["ticker", "signal_date", "signal", "confidence"]].head())
df.to_csv("nexus_signals.csv", index=False)

Bulk CSV export (Tier 2+)

# Up to 10,000 signals — load directly into pandas
df = client.data.export(date_from="2022-01-01")
df.to_csv("nexus_full_history.csv", index=False)
print(f"Downloaded {len(df)} signals")

Real-time WebSocket stream

def on_signal(signal: dict):
    print(f"📡 NEW: {signal['ticker']} → {signal['signal']} (conf={signal['confidence']:.3f})")
    print(f"   {signal.get('rationale', '')}")

# Blocking — runs until Ctrl-C
client.stream(on_signal)

# Non-blocking — runs in background thread
thread = client.stream_async(on_signal)

Test your key

curl https://api.nexusalpha.io/usage \
  -H "X-API-Key: nx_live_your_key_here"

{"tier": 1, "client_name": "Your Fund", "total_calls": 0, ...}

Pull top signals

curl "https://api.nexusalpha.io/signals/top?limit=5" \
  -H "X-API-Key: nx_live_your_key_here" | python3 -m json.tool

Filter by ticker

curl "https://api.nexusalpha.io/signals?ticker=NVDA&min_confidence=0.65" \
  -H "X-API-Key: nx_live_your_key_here"

Download signal history

curl "https://api.nexusalpha.io/signals/history?date_from=2024-01-01&min_confidence=0.65" \
  -H "X-API-Key: nx_live_your_key_here"