Docs
How to call Comparand from Claude Code, another MCP client, or curl.
What it does
Comparand is a research service over Hyperliquid market history. You, or an AI agent working for you, can ask what the market looked like, when it looked like this before, and which liquidation cascades happened on a given day. Every answer says which data it came from and what its limits are.
Comparand does not give forecasts, trade signals, or advice on what to trade. It covers Hyperliquid only.
- Market labels
hl_labelsgives per-minute labels for one coin over a start and end time in the archive.hl_labels_snapshotgives labels for every coin at one UTC minute. $0.005 per row. - Cascade events
hl_cascade_eventsgives the liquidation cascade events for one archive day. $0.005 per row. - Analog search
hl_analogsgives the past moments nearest to one coin's state at one decision time, with the outcome over the next 1 or 4 hours. $0.05 per packet. - Why it matchedThe features behind each match and how far it is from the query, shown with the matches from
hl_analogs. - Live labels
hl_labels_livegives the newest per-minute labels for one coin from the live feed. $0.005 per row. Refused when the data is stale. - Coverage and provenance
hl_coveragegives archive days, the coin list, and which days are complete. Free. Call this first.hl_provenancegives the full provenance record for one archive day. Free.
Not available yet
Get a key
Keys come with a paid plan. Choose a plan on the pricing page, then pay through Stripe Checkout.
- Starter is $19 per month and includes $25 of usage each month.
- Pro is $79 per month and includes $120 of usage each month.
- After you pay, the welcome page shows your key once. Save it then.
If you lose your key, email hello@comparand.xyz. See Support for how replacement works.
Connect Claude Code or another MCP client
The MCP server uses streamable HTTP at https://api.comparand.xyz/mcp. Send your key in the Authorization header on every call.
For Claude Code, run this once. Replace YOUR_API_KEY with your key.
For other MCP clients, add this block to the client's MCP config. Many clients read this shape from a file such as .mcp.json. Check your client's docs for where its file goes.
Do not commit your key to a git repository or paste it into a public place.
Call it with curl
The REST API lives at https://api.comparand.xyz. Every call needs the Authorization header. Pick a complete day from GET /v1/coverage before you ask for a window.
Labels for one coin over a window. This asks for five minutes, so it returns five rows at $0.005 each.
Analogs for one coin at one decision time. This asks for the five nearest past episodes and what followed over one hour. It costs $0.05 per packet.
Replace the coin, the times, and YOUR_API_KEY with your own values. Use a time in the past that the archive covers.
Limits and honesty
- Usage. Call usage to see your key's usage for the current UTC month. It is free.
- Usage caps. Each plan includes a fixed amount of usage each UTC month. When it runs out, calls are refused until the next month. Nothing is billed extra.
- Rate limits. Starter allows 60 requests per minute. Pro allows 300.
- Stale data is refused. Live labels older than 120 seconds return the live_stale error. A refused call is not billed.
- Every answer carries provenance. Each answer has a prov block with the days, digests, and code revisions behind it, and a meter block with what the call cost.
- Analog results are past episodes, not predictions. hl_analogs returns the nearest past moments and what followed. It does not compute an average, a median, or a hit rate.
- Hyperliquid only. Not investment advice.