Command

Description

cryptyx snapshot

Full state snapshot: factor breadth, rankings, signal summary

cryptyx market

Asset universe with composite scores and returns

cryptyx signals

Today's active signal triggers

cryptyx signals top

Top 10 signals by 7d IC

cryptyx signals catalog

All signals with parameters and 30d stats

cryptyx signals explain SIG ASSET DAY

Why a signal fired (or didn't)

cryptyx signals backtest SIG --from --to

Signal backtest over date range

cryptyx signals fork SIG --params '{}'

Fork a signal with new parameters

cryptyx signals simulate SIG --key --value

Estimate trigger rate for threshold change

cryptyx factors ASSET

Factor t-scores across 8 classes

cryptyx regime ASSET

Regime classification with confidence

cryptyx macro-regime

Market-wide macro regime classification across all horizons

cryptyx divergences

Cross-factor divergence alerts (distribution, capitulation, ignition)

cryptyx pulse

Factor breadth across the universe

cryptyx prices

Live spot prices (15m refresh)

cryptyx price ASSET

Daily OHLCV candles

cryptyx assets

Full tracked universe with tags

cryptyx liquidity ASSET

Order book depth at 50/100/200bp

cryptyx metrics featured

Top metrics by IC

cryptyx metrics analyze METRIC ASSET --operator --threshold

Single-metric z-score backtest

cryptyx metrics scan METRIC --operator --threshold

Universe-wide z-score scan

cryptyx metrics composite ASSET --conditions '[...]'

Multi-factor intersection backtest

cryptyx competition

Competition leaderboard

cryptyx competition rounds

All competition rounds

cryptyx config set-key KEY

Save API key

cryptyx config show

Show current config

cryptyx config clear

Clear saved config

Variable

Required

Default

Description

CRYPTYX_API_KEY

Yes

—

API key from cryptyx.ai

CRYPTYX_API_URL

No

https://cryptyx.ai

Override for self-hosted deployments

Tool

What it does

get_featured_metrics

Top-performing metrics by information coefficient. Returns the 8 highest-conviction metrics with A/B grades. Best starting point.

get_asset_top_predictors

Per-asset predictive power — metrics ranked by time-series IC for a specific asset. Surfaces hidden alpha (CS Grade F but TS Grade A).

analyze_metric

Single-metric z-score backtest with forward returns across 8 horizons. The core factor discovery tool.

analyze_metrics_composite

Multi-factor intersection backtest. Define 2-4 metric conditions and see when ALL fire simultaneously, with forward returns at every horizon. This is where theses are born.

scan_metric_universe

Scan a metric across all ~200 assets for z-score extremes on the latest day. Ranked results with forward-return backtests at 1d/7d/30d.

get_factor_scores

Factor t-scores for an asset across 8 factor classes and multiple horizons.

Tool

What it does

get_signal_triggers

Today's active signal firings across all assets. Atomic signals + composite rollups with confidence scores.

get_top_signals

Curated top 10 signals ranked by 7d information coefficient (IC). Pre-filtered to A/B health grade with proven predictive power.

get_signal_catalog

Full signal catalog with active parameters and 30-day trigger statistics.

get_signal_explanation

Structured explanation of why a specific signal fired (or didn't) for an asset on a given day. Returns factor scores and composite context.

backtest_signal

Backtest a signal over any date range. Returns per-day trigger counts + aggregate stats (trigger rate, avg confidence).

fork_signal

Create a new inactive parameter variant of an existing signal. The fork is tracked forever but doesn't affect the live signal. Human approval required to activate.

simulate_signal

Estimate the trigger rate if a signal threshold were changed — without making any changes. Cheap what-ifs.

Tool

What it does

get_market_snapshot

Asset universe with composite scores, returns, rankings. Latest or time series.

get_market_pulse

Factor breadth across the universe. Shows how many assets are positive / negative / neutral per factor class.

get_composite_rankings

Full agent-optimised state snapshot: factor breadth, top/bottom rankings, signal summary, pipeline status. Ideal grounding context before reasoning.

get_regime_analysis

Current regime classification (trending, mean-reverting, volatile) with primary + secondary regime confidence scores.

get_macro_regime

Market-wide macro regime classification across all horizons. Returns regime label, confidence, breadth, and horizon alignment over time.

get_divergences

Cross-factor divergence alerts: distribution (bearish), capitulation (bullish), ignition (bullish). Detects when factor classes disagree — early warning of regime shifts.

get_price_history

Daily OHLCV candles for a single asset.

get_live_prices

15-minute refresh spot prices across all tracked assets.

search_assets

Full tracked universe with universe tags.

Tool

What it does

get_asset_liquidity

Order book depth at 50 / 100 / 200 bp from mid, spot and optionally futures. Critical for sizing real-world execution.

Tool

What it does

get_competition_rounds

List all competition rounds with rules, asset universe, and entry counts.

get_competition_leaderboard

Live leaderboard — ranked entries with Sharpe ratio, total return, max drawdown, composite score.

Code

Name

What it captures

CORR

Correlation

Cross-asset correlation dynamics, regime coupling

EFF

Efficiency

Market efficiency, mean reversion, trend exhaustion

FLOW

Flow

Capital flow, fund movement, stablecoin rotation

FUT

Futures

Derivatives positioning, funding rates, open interest, sentiment

OB

Order Book

Spot and futures depth, bid/ask imbalance, microstructure

OPT

Options

Implied volatility, skew, term structure (BTC/ETH scope)

TR

Trend

Price momentum, trend strength, regime transitions

VOL

Volatility

Realized and implied volatility dynamics, compression/expansion