Documentation / HyperTape
HyperTape
Product site: hypertape.io · Live room: /tape
Paid Hyperliquid L1 tape product: forever archive, REST + WebSocket access, MCP for agents, and source=hyper_tape for backtests. Same MrTrades portal identity and X-Api-Key as the rest of the stack.
Naming
- HyperTape — product name (UI, docs, marketing).
- hypertape.io — public website and API host (same stack as app.mrtrades.com).
/v1/hyper_tape/*and OpenAPI taghyper-tape— stable API identifiers (unchanged in code).
Hosts
Primary product origin is app.mrtrades.com. beta.mrtrades.com still 308s browsers to app.
All of the above reverse-proxy the same Caddy → backend/frontend stack. Paths below are relative to the host you choose.
Keys, registration & billing
- Open the Portal and create an account (or sign in).
- Under API keys, create a key. Copy it once — it is shown as
mtdp_…. - Unlock Tier 2+ from the Portal plan tab. HyperTape REST/WS/MCP require tier ≥ 2.
- Send the key on every request: header
X-Api-Key: mtdp_…
Monthly list prices (USD): Tier 1 $49 · Tier 2 $99 · Tier 3 $199. Tape credits are granted on T2/T3; heavier usage will move to a dedicated HyperTape SKU (see Credits).
Credits
- 1 credit ≈ 1 MB warm data materialized on a cache miss.
- Sealed / already-local hours = 0 credits (download-once forever archive).
- Monthly allotment today: T2 = 500 · T3 = 5 000 (granted once per calendar month).
- Check balance:
GET /v1/hyper_tape/credits
REST API
All routes require tier ≥ 2 unless noted.
| Method | Path | Purpose |
|---|---|---|
| GET | /v1/hyper_tape/coverage | Sealed vs missing hours for a window |
| POST | /v1/hyper_tape/estimate | Credits to materialize misses (cache hit = 0) |
| POST | /v1/hyper_tape/fetch | Promote/materialize missing hours into archive |
| GET | /v1/hyper_tape/trades | Paginated trade slice (HL, prefers node origin) |
| GET | /v1/hyper_tape/credits | Remaining credits + tier |
Estimate then fetch
Read trades
WebSocket — live restream & replay
Endpoint: wss://<host>/v1/hyper_tape/ws
First message must authenticate (no header on bare WS upgrades from some clients):
mode=live— Redismtdp:tradesstream (includes node push when live).mode=replay— ordered trades for the window;speed1–20× (tier-capped later).- Events:
trade,ping,replay_start,replay_end,error.
Swagger / OpenAPI
- Swagger UI — tag hyper-tape
- ReDoc
- openapi.json — codegen / Postman
In Swagger, use Authorize and set the X-Api-Key header (scheme name follows the OpenAPI security entry for portal keys).
MCP tools (LLM / agents)
Agents are another client of the same REST APIs. Hosted (any internet LLM): https://app.mrtrades.com/mcp with header X-Api-Key — put the key in the client config, not the prompt. Local packages: services/hyper_tape_mcp/ (tape-only) and services/mrtrades_mcp (tape + strategies + gated exec).
| Tool | Maps to |
|---|---|
| hyper_tape_coverage | GET /v1/hyper_tape/coverage |
| hyper_tape_estimate | POST /v1/hyper_tape/estimate |
| hyper_tape_fetch | POST /v1/hyper_tape/fetch |
| hyper_tape_credits | GET /v1/hyper_tape/credits |
| backtest_run | GET /v1/backtest/run?source=hyper_tape |
| backtest_universe | GET /v1/backtest/universe |
Prefer the unified server when you also need Nexus/exec: services/mrtrades_mcp (stdio or Streamable HTTP). Tape-only: this package.
Point Cursor / Claude Desktop MCP config at that stdio command. Or skip local Python and call https://app.mrtrades.com/mcp/call. Materialize still burns tape credits under the same key. Strategy tools: Strategies docs.
Microstructure viz (live room + API)
The HyperTape live room at /tape shows print flow, whale lane, OB heat, and a 60s absorption badge for the focus coin. The same metrics are available over REST (no API key required for public viz endpoints on common-universe symbols):
| Endpoint | Purpose |
|---|---|
| GET /v1/viz/absorption | 60s aggressive flow vs price move (absorption bias) |
| GET /v1/viz/liquidity_heatmap | Shallow L2 size × price × time (common universe) |
| GET /v1/viz/flow_map | Top buyer/seller wallets (tier ≥ 2, API key) |
| GET /v1/viz/tape_heat | Print intensity heatmap |
Terminal Heat tab uses the same viz APIs for liquidity heat and flow map; absorption is shown in the HyperTape room stats strip today.
Backtest source
Event/forward-return engine with L1 provenance. source=hyper_tape requires tier ≥ 2 and uses node tape — both hl_node_trade and hl_node_fill_trade (never silently mixes public WS). Live and replay WebSocket prints include aggression when the archive has it. Fetch spends credits; cache hits do not.
UI: /backtest.
Nexus relationship
Nexus is situational awareness (stats, notifications, ticker glance) — typically tier ≥ 1. HyperTape is the L1 tape data product — tier ≥ 2. Same portal account and API keys.
- Nexus: /nexus
- Nexus stats:
GET /v1/nexus/stats(when enabled) - Tape does not replace Nexus; it feeds richer research/backtest and agent workflows that can sit beside Nexus awareness.
Common errors
401 missing_x_api_key/invalid_api_key403 insufficient_tier— need Tier 2+ for HyperTape403 tier_required_for_hyper_tape— backtestsource=hyper_tape- Backtest
note: no_hyper_tape_data— no node-origin rows in range; runfetch/ wait for live push