Intelligence Query API
Ask questions in plain English, get structured JSON intelligence. An LLM intent classifier routes queries to pre-computed analytics endpoints.
Endpoint
/api/intelligence/queryAuthentication
403 tier_required response. Admin users bypass all tier and rate limit checks.Rate Limits
| Tier | Daily Limit | Reset |
|---|---|---|
| Free / Early Access / Pro | Not available | — |
| Institutional | 500 / day | Midnight UTC |
| Enterprise | 5,000 / day | Midnight UTC |
Request Schema
{
"query": "What are the highest conviction assets?",
"format": "json" // optional, default "json"
}| Field | Type | Required | Description |
|---|---|---|---|
| query | string | Yes | Natural language query (1-1000 chars) |
| format | "json" | No | Response format (only "json" supported) |
Success Response
{
"ok": true,
"intent": "conviction_ranking",
"confidence": 0.95,
"query": "What are the highest conviction assets?",
"data": [ ... ],
"source_endpoint": "/api/assets",
"response_time_ms": 142
}Error Responses
unauthorizedMissing or invalid authentication.
tier_requiredTier does not support the Intelligence Query API.
rate_limitedDaily query limit exceeded. Includes used, limit, and resets_at fields.
unknown_intentCould not classify the query. Returns suggested queries.
invalid_queryMalformed request body or empty query.
internal_errorUnexpected server error.
Intent Types (49)
The classifier maps natural language to one of 49 intents across 11 categories and extracts structured parameters. Confidence below 0.5 returns unknown_intent.
Conviction & Ranking(3)
conviction_rankingsort_direction, limitRank assets by composite conviction score
“What are the highest conviction assets?”
conviction_singleasset (required)Conviction score for a specific asset
“What's BTC's conviction score?”
conviction_leaderboardlimitEnriched top/bottom conviction leaderboard with derivatives data
“Show the conviction leaderboard”
Signals(7)
signal_activeasset (optional)Currently firing signals
“What signals are firing on ETH?”
signal_explainsignal_id, asset (required), dayWhy a signal fired (or did not)
“Why did the momentum signal fire on BTC?”
signal_catalognoneList all signals with descriptions, params, trigger rates
“List all available signals”
signal_leaderboardwindow, limitRank signals by performance (confidence, trigger rate)
“Which signals perform best?”
signal_recentnoneMost recent signal triggers across the universe
“Show the most recent signal triggers”
signal_topnoneTop signals by information coefficient (IC)
“Top signals by IC”
signal_historyasset (required), daysHistorical signal events for an asset with forward returns
“Signal history for SOL”
Factors & Regimes(5)
factor_breakdownasset (required), horizonsFactor scores across all 8 classes
“Break down SOL across all factors”
regime_checkasset (required)Regime classification for an asset
“What regime is ETH in?”
regime_universeregime_typeAssets in a specific regime type
“Which assets are trending?”
regime_transitionsasset (optional), hoursRecent regime transitions across assets
“Recent regime transitions”
divergence_alertshorizons (optional CSV)Cross-factor divergence detection — distribution, capitulation, ignition patterns
“What divergences are active?”
Market-Wide(3)
market_pulsehorizons, classesBroad market factor breadth
“How does the market look right now?”
market_briefnoneHigh-level daily market summary
“Give me a market brief”
correlationwindow, assets, limitCross-asset correlation matrix
“Show the correlation matrix”
Metrics(4)
metric_scanmetric_id (required), operator, thresholdScan universe for a metric condition
“Show me assets with funding stress”
metric_backtestmetric_id, asset, operator, threshold (all required)Backtest a single metric on an asset
“Backtest 7d momentum on BTC above 2 sigma”
metric_featurednoneTop-performing metrics by IC and hit rate
“Show top performing metrics”
composite_backtestasset (required), conditions[]Multi-factor intersection backtest
“When did BTC have high momentum AND low vol?”
Asset Intelligence(6)
asset_lookupnoneList tracked assets
“What assets does CRYPTYX track?”
asset_thesisasset (required), horizonAI-generated thesis with evidence
“Generate a thesis for SOL”
top_setupsasset (required), horizonBest trading setups (reversal, continuation, breakout)
“Best setups for BTC”
top_predictorsasset (required), horizonMost predictive signals and metrics for an asset
“Most predictive signals for ETH”
asymmetryasset (required)Asymmetry analysis — funding, skew, OB imbalance, flow
“Asymmetry analysis for BTC”
peer_clusterasset (required), horizon, kFind an asset's nearest peers by factor profile
“Find peers for SOL”
Market Data(5)
liquidity_checkasset (required)Order book depth and liquidity data
“What's BTC's liquidity like?”
funding_rateasset (required), daysPerpetual futures funding rate history
“BTC funding rate history”
taker_flowasset (required), daysTaker buy/sell flow (spot and futures)
“Taker flow for ETH”
iv_surfaceasset (required)Options implied volatility surface (BTC/ETH)
“BTC implied volatility surface”
price_historyasset (required), daysOHLCV price history
“BTC price history”
Intra-Day & Micro-Regime(4)
pulse_snapshotasset (optional), classLatest sub-daily factor t-scores
“Intra-day pulse factor scores”
regime_microasset (optional), regime_typeCurrent micro-regime state per asset
“Current micro-regime states”
regime_timelinedays, asset (optional)Swim-lane timeline of regime transitions
“Regime timeline over the last 90 days”
regime_contextasset (required), horizonRegime context — forward-return stats conditioned on regime
“Regime context for BTC”
Enriched Asset Intelligence(4)
signal_eventsasset (required), daysTriggered signal events with price overlay and forward returns
“Signal events for ETH with price overlay”
conviction_journalasset (required), daysTrailing conviction score trajectory with daily thesis
“Conviction journal for BTC”
composite_signalsasset (optional), modeComposite signal snapshot or recent events
“Composite signal snapshot”
factor_cross_sectionasset (optional)Factor term structure (class x horizon) with breadth and momentum
“Factor cross-section term structure”
Compound Intelligence(5)
market_digestnoneWhat happened today — factors, regime transitions, signals, top movers
“What happened in the market today?”
asset_deep_diveasset (required)Full analysis — conviction, factors, regime, signals, asymmetry, price
“Full analysis of BTC”
opportunity_scanlimitBest opportunities — high conviction + aligned regime + signal confluence
“Best opportunities right now”
risk_monitornoneRisk flags — vol regime, funding stress, negative momentum
“Current risk flags across the universe”
peer_compareassets (required CSV)Side-by-side multi-asset comparison across all dimensions
“Compare ETH and SOL side by side”
Agent Surfaces(3)
trade_ideaslimit, horizonAI-generated trade ideas ranked by conviction
“Give me the top trade ideas”
agent_snapshotnoneFull state snapshot for agent grounding
“Full state snapshot”
unknownQuery does not match any available intent
“What's the weather?”
Full Example
curl -X POST https://cryptyx.ai/api/intelligence/query \
-H "Authorization: Bearer cx_your_api_key" \
-H "Content-Type: application/json" \
-d '{"query": "What signals are firing on BTC?"}'Want to try it interactively?
Open Playground