Developer guide

Build with agents

Agents can already read a user’s exchange account and place orders. What they lack is evidence: how unusual today’s readings are on each coin, what followed similar readings in that coin’s history, and which tested setups are live. CRYPTYX supplies that layer through a remote MCP server and a REST API. This guide shows where it fits, the flows to run, and how to read what comes back. No trading background is assumed.

Where CRYPTYX sits

User

Asks questions, sets the rules, approves any order.

Agent or bot

Claude, ChatGPT, Grok, or your own framework. Calls tools, composes the answer.

Exchange connection

Coinbase, Kraken, Binance, Hyperliquid tools. Reads holdings, executes approved orders.

CRYPTYX

Evidence layer. Receives coin symbols only and returns readings, history and setups.

The agent reads holdings from the exchange, sends only the symbols to CRYPTYX, and combines both. CRYPTYX never receives balances, position sizes or account identifiers, and never places orders. Responses describe what the data shows and what followed in the past. They do not tell anyone to buy or sell; the user’s rules or your bot’s logic decide that.

The engine, layer by layer

Each layer is built from the one below. Most users start at the top with a plain read of one coin; developers and quants can go down to individual readings and build their own conditions.

Layer	What you get	Surface
THE STUDY	One coin, two horizons: readings that stand out, what followed similar readings, setups firing or close	get_coin_study · /api/v1/study
Scan	Many coins at once: which are running hot on crowd, leverage and volatility, and what changed since last week	get_heat_check · /api/v1/heat-check
Notable	The readings furthest from each coin’s norm, across all 669	get_notable_read · /api/v1/notable
Readings	Test one reading: every past episode and the full return profile at 8 horizons	analyze_metric · /api/metrics/slicer
Setups	Combine 2–4 readings across factor families and test them together	analyze_metrics_composite · /api/metrics/slicer/composite
Triggers	Arbitrary definitions, including the gap between two horizons	evaluate_custom_trigger · /api/triggers/custom
Signals	Daily-evaluated conditions with track records; backtest over any range, fork a variant	backtest_signal · simulate_signal · fork_signal

Connect

MCP (any agent client)

Add the remote server and sign in through your client’s OAuth flow. Free accounts get THE STUDY, the scan, the notable read, coverage and data freshness with daily limits; the deeper tools need a Pro account.

remote mcp

https://mcp.cryptyx.ai/api/mcp

Claude Code: /plugin marketplace add cryptyx-ai/agents, install cryptyx, then /mcp to sign in. The plugin adds skills that route questions to the right tools.
Claude, ChatGPT, Grok and others: add the URL above as a custom remote MCP connector and sign in.
Skills source: github.com/cryptyx-ai/agents (MIT). Readable as agent instructions for any framework.

Free tool	Calls per day
get_coin_study	10
get_heat_check	15
get_notable_read	5
check_coverage	30
get_data_liveness	60
get_cryptyx_overview	unlimited

REST (bots and backends)

The same reads are plain HTTPS endpoints. Authenticate with an API key, or pay per call with x402 (USDC on Base) and no account. Full reference in the API reference and x402 guide.

bash

# THE STUDY for one coin
curl -H "Authorization: Bearer $CRYPTYX_API_KEY" \
  "https://cryptyx.ai/api/v1/study?asset=SOL"

# Scan up to 25 coins, with what changed over 7 days
curl -H "Authorization: Bearer $CRYPTYX_API_KEY" \
  "https://cryptyx.ai/api/v1/heat-check?assets=ETH,SOL,DOGE&compare_days=7"

# What stands out on up to 10 coins
curl -H "Authorization: Bearer $CRYPTYX_API_KEY" \
  "https://cryptyx.ai/api/v1/notable?assets=BTC,ETH,SOL"

# Is a coin covered? When did each data source last update? (free)
curl "https://cryptyx.ai/api/v1/coverage?assets=SOL,BONK"
curl "https://cryptyx.ai/api/v1/liveness"

Flows to run

Each flow is a prompt a real user would type, the tools a well-behaved agent should call, and what a good answer contains. Run them in each client you care about. They also make a useful regression suite for your own agent.

1. Research one coin

Anyone, no exchange needed

“How does SOL look right now? What happened the last times it looked like this?”

Expected tools get_coin_study(asset: SOL)

✓Separates the tactical (7–14 day) and structural (60–180 day) pictures.
✓Names the readings that stand out in plain words, with their percentiles.
✓Quotes what followed with the number of episodes and the base rate, not as a prediction.
✓Mentions any setup firing or close to firing with its evidence tier.

2. Check my holdings

Exchange connected in the same agent

“Pull my Coinbase holdings. Which of my coins stand out, and why?”

Expected tools exchange balance tool → get_heat_check(assets) → get_coin_study on the coins that stand out

✓Only symbols reach CRYPTYX; balances stay with the exchange tool.
✓Uncovered coins are named as not covered, not skipped silently.
✓Explains why each coin stands out using the returned readings, not general knowledge.

3. What changed

Recurring check

“Scan ETH, SOL and DOGE. What changed since last week?”

Expected tools get_heat_check(assets, compare_days: 7)

✓Opens with what moved: gauges that flipped, readings that turned, setups that appeared or dropped.
✓Says plainly when nothing changed.

4. Test your own idea

Developers and quants (Pro)

“On BTC, test strong 60-day trend efficiency together with negative funding. Show every horizon against the base rate.”

Expected tools get_featured_metrics → analyze_metric → analyze_metrics_composite

✓Reports episodes, trigger rate, median and mean, hit rate, Sharpe and drawdowns at each horizon.
✓Leads with the difference from the base rate (median_vs_base, hit_rate_vs_base).
✓Relays the response’s warnings verbatim, including small samples.
✓Shows all horizons rather than only the best one, and says how many variants were tried.

5. Feed a bot

Your own code

“Every morning, read THE STUDY for my watchlist and log any reading that crossed into its top or bottom 5%.”

Expected tools GET /api/v1/heat-check (daily) → GET /api/v1/study per coin → your rules

✓Checks /api/v1/liveness first and skips a run when data is stale.
✓Treats CRYPTYX output as an input to its own rules, with its own risk limits.
✓Keeps the decision and any order approval outside CRYPTYX.

Reading the evidence

Every historical number comes with its sample. A few rules keep an agent, or a bot, from over-reading it:

Compare with the base rate before calling anything an effect. The response carries both.
Prefer medians: a few large moves pull the mean.
Under about 15 episodes, treat the result as anecdotal.
Every threshold or horizon tried is another draw. A real effect holds on nearby thresholds and similar coins.
Fields named warnings are written for relay to the user; pass them on as they are.
History is history. Nothing returned is a forecast or advice.

Glossary for non-traders

Reading: One measured quantity for one coin on one day, such as funding paid by leveraged traders or realised volatility over 30 days. CRYPTYX tracks 669 of them across about 190 coins.
z-score: How unusual today's reading is against the same coin's own past year, in standard deviations. +2 means far above the coin's normal; −2 far below.
Percentile: Where today sits in the coin’s own history (own-history percentile) or against all other coins today (market percentile).
Horizon: The window a reading looks over. Tactical readings cover 7–14 days, structural readings 60–180 days. They answer different questions and are never blended.
Factor family: A group of related readings: trend, trend efficiency, volatility, flows, futures positioning, order book, options and correlation.
Episode: A past occasion when a condition held, counted once even if it held for several days in a row.
Forward return: What the price did over the next N days after an episode (7, 30, 90 and more).
Base rate: What the price did over the same N days from every day in the same period, whatever the readings. The comparison point for any condition.
Hit rate: Share of episodes followed by a positive return. Only meaningful next to the base rate: a coin that rose on 58% of all days makes a 60% hit rate unremarkable.
Sharpe: Return per unit of volatility, annualised. A rough quality measure for a stream of returns.
Drawdown: The worst fall from entry along the way, even if the period ended up.
Setup: Two to four conditions across different factor families holding at once. CRYPTYX publishes a catalogue of setups with evidence tiers.
Signal: A condition the engine evaluates daily with a tested track record.

Reporting what you find

When a flow misbehaves, the useful report is: client and model, the prompt, the tools actually called (in order), the part of the answer that was wrong or missing, and the response field it should have used. Send it to support@cryptyx.ai.

CRYPTYX provides historical market statistics. Nothing here is an offer, a solicitation or investment advice, and historical results do not predict future results. You are responsible for your agent’s actions and for any orders you approve. Digital assets carry substantial risk of loss.