Tool reference
All 39 f1ow tools by category — callable over MCP, REST and WebSocket with one API key.
Every tool is a read-only snapshot: it observes the market and never places orders or moves funds. Call any of them as an MCP tool, a REST resource or a WebSocket method with the same key. Each page lists the parameters, request examples and a real sample response. For agents, every page also has a Markdown twin: append .md to the URL.
Research & risk
Composite reads that assemble many sources into one answer: market regime, positioning, setup scans, token dossiers and trade-plan checks.
research_regimeWhat kind of market you are trading in. Seven forces — trend, volatility, cycle, sentiment, leverage stress, ETF liquidity, rotation — each voting with its own reasoning and its own threshold for changing the call.
research_positioningWho is on the other side of your trade. Up to eight reads on one coin — who is crowded, who is fragile, who is trapped — plus the price levels the whole board is watching.
research_opportunitiesA liquidity-qualified major and mid-cap universe screened on crowding, stress, leverage, compression, trend, location and entry quality. Ranked candidates with disclosed setup rules and entry, stop and target geometry — not a forecast or a proven edge.
research_trade_planCheck your entry, stop and target against ATR, perp levels, liquidation distance, fees, slippage and funding. Add account size and risk for sizing, or a placement time to replay a trade from public candles. An interactive ticket in MCP Apps hosts; no orders placed or plans stored.
research_token_viewOne coin, fully assembled. Market data, technicals, on-chain, cited narrative synthesis, catalysts, social, ETF flows and prediction odds — the entire dossier from a single call.
Market data
Quotes, candles, paged history, market breadth, movers and coin metadata.
market_quotesSpot and perp mark side by side, with funding, open interest, long/short ratio and the day's liquidations. Five providers merged into one snapshot, cached for thirty seconds.
market_candlesSpot or perpetual OHLCV candles with venue routing and fallback, for the timeframes your analysis needs. For months of paged candles or derivatives series, use Bulk History.
market_historyPaged spot/perp candles, aggregate open interest, funding or long/short liquidations. Up to 1,000 rows per call with a backward-page cursor, explicit time bounds and a forming-row flag — for historical research and backtests.
market_overviewThe global frame in one read: total market cap, BTC and ETH dominance, Fear & Greed, Altcoin Season.
market_top_moversThe day's ranked gainers and losers, plus the quieter names already trending more than five percent.
market_trendingWhat the market is looking up right now, ranked.
market_coin_detailsPrice, market cap, all-time high and low, and the project's own description of itself.
market_coinsEvery symbol the market-data providers can answer for, so your agent knows what it can ask about before it asks.
Derivatives
Perpetual funding, open interest, liquidations and taker flow across venues.
derivatives_flowBucket-by-bucket open interest joined to taker buy/sell volume. Distinguish new positions from short covering and long unwind, with absorbed flow flagged. Coverage is stated; where taker data is unavailable, the read uses price direction and says so.
derivatives_liquidationsMarket-wide long/short liquidations and venue splits, ranked against a year of daily totals. A separate order sample reveals timing, cascades and the largest forced exits; its coverage is stated, never scaled up to the whole market.
funding_currentCurrent perpetual funding, normalized to an eight-hour rate and annualized, with history and a one-year percentile baseline. Positive means longs pay shorts; it is a cost of holding, not a direction forecast.
derivatives_open_interestCross-exchange perpetual open interest with historical changes and a one-year baseline — how much leverage is committed, not merely how much changed hands. Venue-specific flow is a separate read.
Options
Chains, implied volatility, positioning, modeled gamma and risk-neutral expiry odds.
options_chainCalls and puts by strike and expiry: quotes, mark implied volatility, open interest and volume. Reported data is separated from calculated metrics, with coverage and thin-market caveats.
options_volatilityATM volatility, term structure, implied move size, 25-delta skew and IV versus realized volatility. BTC/ETH volatility-index history adds context. What options price for the size of a move — not its direction.
options_positioningPut/call open interest, strike and expiry concentrations, expiring notional, theoretical max pain and recent option trades. One venue; aggregate open interest does not reveal who is long or short, and max pain is not a forecast.
options_gammaModeled gamma exposure, walls, flip levels and an options regime, with price, time and volatility what-ifs. Dealer hedge ladders depend on an explicit positioning scenario — theoretical sensitivity, not observed dealer orders.
options_probabilityRisk-neutral expiry probabilities above or below a price or inside a range, plus implied 68% and 90% ranges. Derived from options forwards and volatility, with smile adjustment where quoted — not calibrated real-world forecasts.
Order flow & whales
Order books, evidence-graded price levels, whale positions and cohort flow.
flow_whale_positionsLive whale accounts: equity, side, notional, entry, leverage, unrealized PnL — and the reported liquidation price of each position.
flow_orderbookBest bid and ask, spread, depth and imbalance, with venue-labelled books and resting walls. Orders can be pulled: visible liquidity is evidence, not a promise of execution.
flow_levelsExecuted volume profiles, value areas, thin zones, inferred long/short entries, realized liquidation prices and persistent resting walls across venues. Levels graded by traded, inferred or resting evidence, with confluence disclosed — not a price forecast.
flow_whale_contextThe cohort view: exchange reserve changes, top-trader long/short lean, and the large exchange-linked transfers that tend to arrive before a move does.
Technicals
Multi-timeframe indicators computed from candles.
Sentiment
Fear & Greed, social attention and live posts.
sentiment_fear_greedThe market-wide Fear & Greed index, 0 to 100 with the label that goes with it. One number for how the crowd is feeling.
sentiment_socialPer-coin social composite: galaxy score, alt rank, bullish share, social volume, dominance and interactions. How much attention a coin is getting, and from whom.
sentiment_twitterRaw crowd voice: public X posts from the last seven days on a coin, a topic or a single account, with likes, reposts, replies and views attached, so volume can be weighed against actual reach.
News & filings
Cited news search and regulatory filings.
Events & catalysts
ETF flows, economic and crypto calendars, and prediction-market odds.
catalysts_etf_flowsDaily spot-ETF net flows for BTC, ETH, SOL and XRP — the latest day, the per-fund breakdown, and the trailing trend it has to be read against.
events_prediction_oddsWhat real money says about a question: per-outcome probabilities, the volume standing behind them, and when the market resolves.
catalysts_calendarCrypto events landing inside the next seven days, filterable to a single coin when only its own catalysts matter.
catalysts_economic_calendarCPI, FOMC, jobs and GDP — the macro releases that move crypto anyway — from two days back to a week ahead, filtered by importance.
catalysts_exchange_listingsOfficial venue notices for new listings, delistings and other trading changes, with scheduled times, recent history, and coin or venue filters.
On-chain
Chain-level activity, TVL and fees.
Utilities
A UTC clock, so an agent can judge how fresh a read is.
Start with a free trial
Sign in, get an API key and make your first call in under a minute. No card required.
For agents: this page as Markdown · all docs
WebSocket API
Stream crypto market data from f1ow over WebSocket — JSON-RPC 2.0 tool calls and subscriptions that push only when a result changes.
Market Regime
What kind of market you are trading in. Seven forces — trend, volatility, cycle, sentiment, leverage stress, ETF liquidity, rotation — each voting with its own reasoning and its own threshold for changing the call.