io.github.midasflowai-lab/midasflow-mcp-quickstart

Official14 tools

by midasflowai-lab

Agent-native crypto market-data over MCP+REST: order flow, whales, liquidations, calibrated scores

Access crypto market data including order flow, whale activity, and liquidation signals.

Topics

ai-agentscryptomarket-datamcpmodel-context-protocoltrading

Captured live from the server via tools/list.

get_signals

Pull recent MidasFlow SignalEvent records (newest first). quality='normal' (default) = the bucketed signal log across source families; quality='elite' = the rare highest-conviction multi-model-consensus crown feed (premium+, lagged anti-front-run). Tier-gated + moat-scrubbed server-side. Market DATA, not advice. Routes: normal→/v1/signals/pull, elite→/v1/signals/elite.

Parameters (5)

sourcestring
Source-family filter: '' / 'all' | 'pump' | 'flow' | 'mfb' (case/space-insensitive). Ignored when quality='elite'.
qualitystring
'normal' (default, /v1/signals/pull) | 'elite' (crown consensus feed, /v1/signals/elite, premium+).
symbolstring
Single symbol filter, e.g. 'BTCUSDT' (empty = all symbols).
limitinteger
Max events to return (normal 1-200, elite 1-50; clamped server-side). Default 20.
cursornumber
Pagination cursor (normal feed only) — pass 'next_cursor' from the previous page for older events (0 = newest).

score_symbol

CROWN data product: calibrated P(first TP1 before SL) band + coarse trade plan (TP ladder %, SL %, weights) for ONE symbol, FOLDED with a pre-trade feed-safety check (is the feed live/real-volume/fresh, no phantom ticks). Coverage is present-or-null — most symbols return p_tp1_band=null (valid, NOT an error). Feed the band into calc_ev; never read it as buy/sell. Routes: /v1/score/{symbol} + folds /v1/symbol/check as `safety`.

Parameters (3)

symbolstringrequired
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive). A calibrated score exists only for recently-evaluated symbols; most return p_tp1_band=null (valid).
directionstring
'long' | 'short' — steers the plan ladder only; the P(TP1) score itself is direction-agnostic.
include_safetyboolean
If true (default), also fold a /v1/symbol/check feed-safety read into the response under `safety`. Set false to skip that extra call.

get_candles

Recent OHLCV candle bars for a symbol at a chosen timeframe — the raw price/volume history other tools are derived from. Inspect trend, range, volatility, volume profile, or feed your own indicators. Market DATA, not advice. A symbol outside the candle store returns an empty bars list (normal, not an error). Routes: /v1/candles/{symbol}.

Parameters (3)

symbolstringrequired
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive).
tfstring
Timeframe / bar size, e.g. '1m' | '5m' | '15m' | '1h' | '4h' | '1d'. Default '1h'.
limitinteger
Max bars, newest last (1-1000; clamped server-side). Default 200.

get_orderbook

Live order-book snapshot for a symbol — bid/ask walls, book imbalance, spread — FOLDED with support/resistance levels (classic TA fused with cross-exchange book walls + Fibonacci) so you see resting liquidity AND the level map in one call. Cross-exchange aggregate, derived levels only. Market DATA, not advice; thin/uncovered symbols return null fields (normal). Routes: /v1/orderbook/{symbol} + folds /v1/sr as `sr`.

Parameters (3)

symbolstringrequired
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive). Resolves the cross-venue aggregate.
include_srboolean
If true (default), fold support/resistance + Fibonacci levels (/v1/sr) into the response under `sr`. Set false to skip.
sr_timeframestring
Timeframe for the folded S/R computation. Default '1h'.

get_flow

Per-symbol order-flow microstructure, grouped by `kind`. kind='vpin'/'all' (default)=full snapshot (CVD trend+divergence, VPIN toxicity, sweep state, buy/whale aggression, /v1/flow); 'cvd'=CVD series (/v1/cvd); 'sweeps'=stop-sweep events (/v1/sweeps); 'cross'=cross-exchange flow origin (/v1/cross_flow). Realtime market CONTEXT, NOT advice / a win-rate. Empty/unknown kind → a menu of kinds. VPIN is ONE contested signal — pair with get_accuracy before treating it as edge.

Parameters (2)

symbolstring
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive). Resolves the cross-venue aggregate.
kindstring
'vpin'/'all' (full /v1/flow snapshot, default) | 'cvd' (/v1/cvd series) | 'sweeps' (/v1/sweeps) | 'cross' (/v1/cross_flow origin). Empty/unknown → menu.

get_heatmap

Liquidation-heatmap matrix for a symbol — price levels where leveraged positions cluster and are likely force-liquidated (price-magnet zones / liquidity pools). Anticipate where a move may accelerate or stall. Market DATA, not advice; a symbol with no clustering returns an empty matrix (normal, not an error). Routes: /v1/heatmap/{symbol}.

Parameters (1)

symbolstringrequired
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive).

get_context

Contextual market reads, grouped by `kind`. kind='regime'=market-regime labels (/v1/regime, market-wide, no symbol needed); 'phase'=move-lifecycle / entry-timing for a symbol (/v1/phase, premium+); 'derivatives'=normalized cross-exchange funding/OI/basis summary (/v1/derivatives); 'funding'=PER-VENUE funding+OI (/v1/funding); 'squeeze'=liquidation-cascade proximity (/v1/squeeze); 'intel'=per-symbol aggregated signal-quality roll-up (/v1/intel). Market DATA / context, NOT advice and NOT a win-rate. Empty/unknown kind → a menu of kinds.

Parameters (2)

kindstring
'regime' (market-wide, /v1/regime) | 'phase' (/v1/phase) | 'derivatives' (/v1/derivatives) | 'funding' (/v1/funding) | 'squeeze' (/v1/squeeze) | 'intel' (/v1/intel). Empty/unknown → menu.
symbolstring
Perp symbol, e.g. 'BTCUSDT' (required for every kind EXCEPT 'regime', which is market-wide). Case/space-insensitive.

get_whales

Large-player / forced-flow intel, grouped by `kind`. kind='whales' (default)=recent large ('whale') prints for a symbol, banded size+side (/v1/whales); kind='liquidations'=multi-exchange liquidation prints over a rolling window, long-liq vs short-liq notional bands per venue (/v1/liquidations; empty symbol = market-wide top movers by liq notional). Raw notional is banded. Market DATA, NOT a signal/advice. Empty/unknown kind → a menu of kinds.

Parameters (4)

symbolstring
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive). Required for kind='whales'; empty for kind='liquidations' = market-wide top movers.
kindstring
'whales' (default, /v1/whales) | 'liquidations' (/v1/liquidations). Empty/unknown → menu.
windowinteger
Liquidations lookback seconds, 1-300 (kind='liquidations' only; clamped). Default 60.
exchangestring
Liquidations venue filter (kind='liquidations' only): '' / 'all' for the full market, or a single major CEX. Unknown venue = error.

get_market

Whole-market reads, grouped by `kind`. kind='movers' (default)=top movers ranked (/v1/movers); 'overview'=whole-market roll-up — breadth / direction / activity (/v1/market); 'anomalies'=per-symbol or cross-market anomaly board (volume_spike/abnormal_spread/phantom_tick) with severity bands (/v1/anomalies). Cheap top-level CONTEXT to find what's MOVING before drilling into one symbol. Market DATA, NOT advice. Empty/unknown kind → a menu of kinds.

Parameters (3)

kindstring
'movers' (default, /v1/movers) | 'overview' (/v1/market) | 'anomalies' (/v1/anomalies). Empty/unknown → menu.
symbolstring
Anomalies single-symbol filter (kind='anomalies' only; empty = cross-market board). Case/space-insensitive.
limitinteger
Max rows for movers (1-100, default 24) / anomalies (1-200, default 20); clamped server-side.

get_accuracy

Realized track-record (proof of edge, forward-only, Wilson-bounded), grouped by `kind`. kind='accuracy' (default)=source×boost first-TP win-rate + boost lift in the canonical TP1 frame (/v1/accuracy); kind='outcomes'=realized aggregate track-record over a window from resolved signal_outcomes, model-free (/v1/outcomes). Win-rate frame = P(price hit TP1 before SL), NOT realized PnL. Model internals never exposed. Empty/unknown kind → a menu of kinds.

Parameters (3)

kindstring
'accuracy' (default, /v1/accuracy) | 'outcomes' (/v1/outcomes). Empty/unknown → menu.
sourcestring
Source-family filter (kind='accuracy', client-side): '' = all | 'pump' | 'flow' | 'breakout' | 'unified' | 'other'.
windowinteger
Track-record window in days (kind='outcomes'; passed through to /v1/outcomes). 0 = endpoint default.

account

Your mf_ key's account view, grouped by `kind`. kind='account' (default)=tier/product, weighted daily quota, used/remaining today, billing, prepaid balance (/v1/account); kind='usage'=today's count + cap AND the endpoint_weights map (exact per-call cost units, /v1/usage); kind='tiers'=the Flow data-product tier ladder, delivered-now vs roadmap (/v1/tiers). Read account/usage to self-throttle by your remaining quota. Empty/unknown kind → a menu of kinds.

Parameters (1)

kindstring
'account' (default, /v1/account) | 'usage' (/v1/usage — incl endpoint_weights) | 'tiers' (/v1/tiers). Empty/unknown → menu.

backtest

LAB / RESEARCH tool — replay an arbitrary {symbol, entry, tp, sl} setup over MidasFlow's 1m candle history and get its historical P(TP1-before-SL) + EV, in the canonical first-touch TP1 frame (same frame as get_accuracy). Historical market DATA, NOT a prediction or advice. Low-sample setups return a directional band (normal, not an error). NOTE: live results are gated behind ff:backtest_live — until that flips, EVERY tier gets a coming-soon envelope (no live numbers). Routes: POST /v1/backtest.

Parameters (6)

symbolstringrequired
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive).
entrynumberrequired
Entry price; defines the TP/SL offsets replayed over historical anchors.
tpanyrequired
Take-profit price, or an ordered list of prices (nearest = TP1 banked first).
slnumberrequired
Stop-loss price. Direction (long/short) is inferred from tp/sl vs entry.
lookback_daysinteger
Historical window to sample anchors from, in days (clamped 7-90). Default 30.
max_hold_mininteger
Forward first-touch window per anchor in minutes (clamped 15-1440). Default 240. Timeout anchors are excluded from p, not losses.

analyze

LAB / RESEARCH tool — the full MidasFlow AI-Analyst report for a symbol: a synthesized narrative fusing flow, derivatives, levels, regime and signal context into a human-readable read RIGHT NOW. This is the HEAVIEST call (composes many sub-feeds) so it costs MORE units and requires a TOP tier; call it sparingly, AFTER cheaper context tools. Market DATA / AI-generated analytics, NOT financial advice. Routes: /v1/analyze/{symbol}.

Parameters (2)

symbolstringrequired
Perp symbol, e.g. 'BTCUSDT' (case/space-insensitive).
langstring
Report language, e.g. 'en' | 'ru' | 'uk' | 'es' (BCP-47-ish). Default 'en'.

calc_ev

LAB tool — pure local expected-value calculator over a win-rate and average win/loss percentages. No network, no advice, 0 units. Feed a get_accuracy bucket win-rate (or a score_symbol band) to reason about expectation per trade.

Parameters (4)

win_rate_pctnumberrequired
Probability of a winning trade, in percent (0–100). Feed from a get_accuracy bucket win-rate.
avg_win_pctnumberrequired
Average gain on a win, in percent (e.g. 2.0 = +2%).
avg_loss_pctnumberrequired
Average loss on a loss, in percent magnitude (e.g. 1.5 = -1.5%). Sign is ignored.
stake_usdnumber
Notional stake to scale EV into dollars. Default 100.

README.md3 KBView on GitHub

MidasFlow Flow API — MCP Quickstart

Agent-native crypto market-data feed for AI agents and LLMs. Connect Claude, ChatGPT, Cursor, or any MCP-compatible agent to cross-exchange order flow, whale prints, liquidations, derivatives context, anomaly/squeeze detection, and calibrated P(TP1) scores — over a native Model Context Protocol (MCP) server or plain REST, with one Bearer key.

⚠️ Market DATA, not financial advice. And not the Flow (FLOW) blockchain — this is MidasFlow Flow API.

MCP server: https://mcp.midasflow.ai/mcp
REST base: https://mcp.midasflow.ai/v1
Keyless schema (self-describing, no auth): https://mcp.midasflow.ai/v1/schema
Docs: https://midasflow.ai/docs/api
Get a key: https://midasflow.ai/app/ (free tier — 200 units/day)

What it gives an agent

A single Bearer-key feed of cross-exchange crypto market DATA, shaped for an LLM to reason over:

Order flow — CVD, cross-exchange flow origin (where the aggression actually comes from)
Whale prints + multi-exchange liquidations + liquidation heatmap
Derivatives context — funding, open interest, basis
Anomalies, squeeze proximity, regime/phase context, support/resistance, sweeps
Calibrated P(TP1) scores + structured trade plans (size by expectancy, not vibes)
Realized track-record / accuracy feeds (honest win-rate with confidence bounds)

The agent discovers the full, current tool + field set itself from the keyless schema — no hardcoded parser to break:

bash

curl -s https://mcp.midasflow.ai/v1/schema | jq '.tiers, .endpoints[].path'

Connect

Claude Code / CLI (remote MCP)

bash

claude mcp add --transport http midasflow https://mcp.midasflow.ai/mcp \
  --header "Authorization: Bearer mf_live_YOUR_KEY"

Claude Desktop (config)

See examples/claude_desktop_config.json. Add the midasflow block to your mcpServers and replace the key.

Any MCP client

Point it at the remote Streamable-HTTP endpoint https://mcp.midasflow.ai/mcp with header Authorization: Bearer mf_live_YOUR_KEY.

REST (no MCP client needed)

See examples/rest_quickstart.sh:

bash

# whole-market context (cheap), then a per-symbol calibrated score
curl -s -H "Authorization: Bearer mf_live_YOUR_KEY" https://mcp.midasflow.ai/v1/market
curl -s -H "Authorization: Bearer mf_live_YOUR_KEY" https://mcp.midasflow.ai/v1/score/BTCUSDT

Tiers (agent / API — daily weighted units)

Tier	Price	Units/day	Notes
Free	$0	200	feed ~15 min lagged; great for poking the schema
PRO	$49/mo	750	real-time
VIP	$99/mo	1,500	real-time + raw PUMP + per-signal edge band
Prime	$199/mo	8,500	model scores + MFBreakout
Apex	$399/mo	16,600	everything + priority rate-limit / queue

Each tier also includes the human-facing Telegram bot. A "unit" is a weighted cost (context calls ~1, heavy crown calls up to ~12); see GET /v1/usage for live weights.

License

The sample code in this repo is MIT (see LICENSE). The MidasFlow Flow API service itself is proprietary / commercial.

MidasFlow Flow API — market DATA for AI agents. Founded 2022. Not financial advice; not the Flow (FLOW) blockchain.

Install

claude_desktop_config.json

{
  "mcpServers": {
    "midasflow-mcp-quickstart": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.midasflow.ai/mcp"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.