# Tool reference

> Every f1ow tool, callable over MCP, REST and WebSocket with the same credentials.

## Research & risk

Composite reads that assemble many sources into one answer: market regime, positioning, setup scans, token dossiers and trade-plan checks.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Market Regime](https://www.f1ow.com/docs/tools/research_regime) `research_regime` | `GET /research/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. |
| [Positioning](https://www.f1ow.com/docs/tools/research_positioning) `research_positioning` | `GET /research/positioning/{symbol}` | Who 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. |
| [Opportunity Scan](https://www.f1ow.com/docs/tools/research_opportunities) `research_opportunities` | `GET /research/opportunities` | A 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. |
| [Trade Plan Review](https://www.f1ow.com/docs/tools/research_trade_plan) `research_trade_plan` | `POST /research/trade-plan` | Check 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. |
| [Token Dossier](https://www.f1ow.com/docs/tools/research_token_view) `research_token_view` | `GET /research/tokens/{symbol}` | One 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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Spot & Perp Quotes](https://www.f1ow.com/docs/tools/market_quotes) `market_quotes` | `GET /market/quotes` | Spot 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. |
| [Candles](https://www.f1ow.com/docs/tools/market_candles) `market_candles` | `GET /market/candles/{symbol}` | Spot 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. |
| [Bulk History](https://www.f1ow.com/docs/tools/market_history) `market_history` | `GET /market/history/{symbol}` | Paged 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 Overview](https://www.f1ow.com/docs/tools/market_overview) `market_overview` | `GET /market/overview` | The global frame in one read: total market cap, BTC and ETH dominance, Fear & Greed, Altcoin Season. |
| [Top Movers](https://www.f1ow.com/docs/tools/market_top_movers) `market_top_movers` | `GET /market/movers` | The day's ranked gainers and losers, plus the quieter names already trending more than five percent. |
| [Trending](https://www.f1ow.com/docs/tools/market_trending) `market_trending` | `GET /market/trending` | What the market is looking up right now, ranked. |
| [Coin Details](https://www.f1ow.com/docs/tools/market_coin_details) `market_coin_details` | `GET /market/coins/{coin_id}` | Price, market cap, all-time high and low, and the project's own description of itself. |
| [Coin Universe](https://www.f1ow.com/docs/tools/market_coins) `market_coins` | `GET /market/coins` | Every 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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Perp Flow](https://www.f1ow.com/docs/tools/derivatives_flow) `derivatives_flow` | `GET /derivatives/flow/{symbol}` | Bucket-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. |
| [Liquidation History](https://www.f1ow.com/docs/tools/derivatives_liquidations) `derivatives_liquidations` | `GET /derivatives/liquidations/{symbol}` | Market-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](https://www.f1ow.com/docs/tools/funding_current) `funding_current` | `GET /derivatives/funding/{symbol}` | Current 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. |
| [Open Interest](https://www.f1ow.com/docs/tools/derivatives_open_interest) `derivatives_open_interest` | `GET /derivatives/open-interest/{symbol}` | Cross-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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Options Chain](https://www.f1ow.com/docs/tools/options_chain) `options_chain` | `GET /options/chain/{currency}` | Calls 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. |
| [Implied Volatility](https://www.f1ow.com/docs/tools/options_volatility) `options_volatility` | `GET /options/volatility/{currency}` | ATM 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 Positioning](https://www.f1ow.com/docs/tools/options_positioning) `options_positioning` | `GET /options/positioning/{currency}` | Put/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. |
| [Gamma & Hedge Scenarios](https://www.f1ow.com/docs/tools/options_gamma) `options_gamma` | `GET /options/gamma/{currency}` | Modeled 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-Implied Odds](https://www.f1ow.com/docs/tools/options_probability) `options_probability` | `GET /options/probability/{currency}` | Risk-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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Whale Positions](https://www.f1ow.com/docs/tools/flow_whale_positions) `flow_whale_positions` | `GET /flow/whale-positions` | Live whale accounts: equity, side, notional, entry, leverage, unrealized PnL — and the reported liquidation price of each position. |
| [Order Book](https://www.f1ow.com/docs/tools/flow_orderbook) `flow_orderbook` | `GET /flow/orderbook/{symbol}` | Best 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. |
| [Perp Price Levels](https://www.f1ow.com/docs/tools/flow_levels) `flow_levels` | `GET /flow/levels/{symbol}` | Executed 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. |
| [Whale Context](https://www.f1ow.com/docs/tools/flow_whale_context) `flow_whale_context` | `GET /flow/whales/{symbol}` | The 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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Technicals](https://www.f1ow.com/docs/tools/ta_technicals) `ta_technicals` | `GET /technicals/{symbol}` | Multi-timeframe trend, RSI, MACD, ADX, ATR, volatility and structure, calculated from candles. Choose spot, perp or automatic routing, with source coverage and partial-candle handling disclosed. |

## Sentiment

Fear & Greed, social attention and live posts.

| Tool | REST | What it answers |
| --- | --- | --- |
| [Fear & Greed](https://www.f1ow.com/docs/tools/sentiment_fear_greed) `sentiment_fear_greed` | `GET /sentiment/fear-greed` | The market-wide Fear & Greed index, 0 to 100 with the label that goes with it. One number for how the crowd is feeling. |
| [Social Sentiment](https://www.f1ow.com/docs/tools/sentiment_social) `sentiment_social` | `GET /sentiment/social/{symbol}` | Per-coin social composite: galaxy score, alt rank, bullish share, social volume, dominance and interactions. How much attention a coin is getting, and from whom. |
| [Tweet Search](https://www.f1ow.com/docs/tools/sentiment_twitter) `sentiment_twitter` | `GET /sentiment/twitter` | Raw 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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [News](https://www.f1ow.com/docs/tools/news_search) `news_search` | `GET /news` | Recent coverage on any topic, drawn from a crypto news aggregator and a live search model at the same time. |
| [Regulatory Filings](https://www.f1ow.com/docs/tools/filings_search) `filings_search` | `GET /filings` | Full-text search across recent regulatory filings, with form type, filer, and a link to the document itself. |

## Events & catalysts

ETF flows, economic and crypto calendars, and prediction-market odds.

| Tool | REST | What it answers |
| --- | --- | --- |
| [ETF Flows](https://www.f1ow.com/docs/tools/catalysts_etf_flows) `catalysts_etf_flows` | `GET /catalysts/etf-flows` | Daily 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. |
| [Prediction Odds](https://www.f1ow.com/docs/tools/events_prediction_odds) `events_prediction_odds` | `GET /events/prediction-odds` | What real money says about a question: per-outcome probabilities, the volume standing behind them, and when the market resolves. |
| [Crypto Calendar](https://www.f1ow.com/docs/tools/catalysts_calendar) `catalysts_calendar` | `GET /catalysts/calendar` | Crypto events landing inside the next seven days, filterable to a single coin when only its own catalysts matter. |
| [Macro Calendar](https://www.f1ow.com/docs/tools/catalysts_economic_calendar) `catalysts_economic_calendar` | `GET /catalysts/economic-calendar` | CPI, FOMC, jobs and GDP — the macro releases that move crypto anyway — from two days back to a week ahead, filtered by importance. |
| [Exchange Listings](https://www.f1ow.com/docs/tools/catalysts_exchange_listings) `catalysts_exchange_listings` | `GET /catalysts/exchange-listings` | Official 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.

| Tool | REST | What it answers |
| --- | --- | --- |
| [On-Chain Metrics](https://www.f1ow.com/docs/tools/onchain_metrics) `onchain_metrics` | `GET /onchain/{symbol}` | Total value locked and the fees a chain actually earns, over 24 hours, a week and a month. What the protocol makes, not what it promises. |

## Utilities

A UTC clock, so an agent can judge how fresh a read is.

| Tool | REST | What it answers |
| --- | --- | --- |
| [UTC Anchor](https://www.f1ow.com/docs/tools/utc_time) `utc_time` | `GET /time` | The current UTC instant, so your agent can fix what “now” means and judge for itself how stale a read is. |