Intelligence Query API

Ask questions in plain English, get structured JSON intelligence. An LLM intent classifier routes queries to pre-computed analytics endpoints.

Endpoint

POST/api/intelligence/query

Authentication

Tier Required: Institutional or Enterprise. Free and Pro tiers receive a 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

json

{
  "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

json

{
  "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

401

unauthorized

Missing or invalid authentication.

403

tier_required

Tier does not support the Intelligence Query API.

429

rate_limited

Daily query limit exceeded. Includes used, limit, and resets_at fields.

200

unknown_intent

Could not classify the query. Returns suggested queries.

400

invalid_query

Malformed request body or empty query.

500

internal_error

Unexpected server error.

Intent Types (15)

The classifier maps natural language to one of these intents and extracts structured parameters. Confidence below 0.5 returns unknown_intent.

conviction_rankingsort_direction, limit, asset_filter

Rank 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?”

signal_activeasset (optional)

Currently firing signals

“What signals are firing on ETH?”

signal_explainsignal_id, asset (required), day

Why a signal fired (or did not)

“Why did the momentum signal fire on BTC?”

factor_breakdownasset (required), horizons

Factor 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_type

Assets in a specific regime type

“Which assets are trending?”

market_pulsehorizons, classes

Broad market factor breadth

“How does the market look right now?”

metric_scanmetric_id (required), operator, threshold

Scan 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”

composite_backtestasset (required), conditions[]

Multi-factor intersection backtest

“When did BTC have high momentum AND low vol?”

asset_lookupnone

List tracked assets

“What assets does CRYPTYX track?”

market_briefnone

High-level daily market summary

“Give me a market brief”

liquidity_checkasset (required)

Order book depth and liquidity data

“What's BTC's liquidity like?”

unknown

Query does not match any available intent

“What's the weather?”

Full Example

bash

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