One-call market brief
market_briefRead-onlyIdempotent
A complete current market brief for ONE coin in a single call: price, cross-venue funding with carry, open interest, whale flow versus the coin's own baseline, recent liquidations and historical context. The plain-English name for trade_context (identical data and credit cost). Use for a general "what is happening with BTC / how is ETH positioned" question, and do not also call the separate whale, funding or liquidation tools unless the user drills into one of them. Descriptive market data only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | No | Alias for pair. | |
| pair | No | Trading pair, for example ETH/USD. A bare symbol like ETH is read as ETH/USD. Defaults to BTC/USD when omitted. Any streamed pair answers keyless; off the free pairs a keyless reply is the lite shape and names what it withheld in locked_layers. | |
| compact | No | Return one line of plain text rather than the JSON blob, about 30 tokens instead of 800. Same facts, same windows, same dates, no structured fields to read. Defaults to false. | |
| position_usd | No | Position size in US dollars, for example 25000. Above zero only. When given, carry_cost adds per_day_usd_at_current_rate, the dollars a day the current funding average across exchanges works out to at that size. Arithmetic on the rate as it stands now, not a projection of future rates. Omit and carry_cost still carries the percentage and APR figures. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| line | No | The composed one-line answer, returned only when compact:true was asked for. The same facts, the same windows and the same dates as the full shape. | |
| note | No | One line saying what the numbers cover, or why there are none. Read it before reporting any zero as a market reading. | |
| pair | No | The pair this context describes. | |
| depth | No | Which shape came back: lite, free-pair or keyed. | |
| price | No | Last traded price. | |
| compact | No | Present and true only on a compact:true call, where the whole answer is the single line in `line`. | |
| funding | No | average_rate across exchanges, how many exchanges are in it, the interval in hours, and minutes to the next funding time. | |
| crowding | No | The crowding read and the overexposed side. Null without a paid plan. | |
| available | No | False when this lane could not answer: a producer is dark, the pair sits outside this plan, or the argument named something we do not carry. Absent or true means the numbers are a real reading, not a guess. | |
| stats_24h | No | The 24h statistics block. Absent on the lite shape, where locked_layers names it. | |
| carry_cost | No | Arithmetic on the current funding average: percent per day, the same as an annual rate, which side pays, and dollars a day when position_usd was passed. Not a projection of future rates. | |
| whale_flow | No | Whale direction against the same coin logged baseline: the multiple, days logged, record and N-day-high flags, and buy share now versus 7 days. Dollar sizes are added on a paid plan. | |
| price_reads | No | Plain descriptions of price against its own recent hours, computed from hourly candles: vs_recent_average (above or below its 50-hour and 200-hour average, and which way it is drifting), recent_move (how stretched the latest move is, plus the change against 7 days ago) and choppiness (calm, normal or choppy). Each block is available:true with values or available:false with a plain reason; a leg with too few recorded hours is null with a note, never a made-up neutral. Descriptive, not a trade signal. | |
| locked_layers | No | Named rather than silently missing: which blocks this connection did not receive. | |
| vs_own_history | No | Where funding and open interest sit against the same pair recorded days: phrase, band, day count, the date the reading is from, and how past cases resolved. | |
| open_interest_usd | No | Open interest in dollars across the exchanges that publish it. | |
| liquidations_recent | No | Forced closes visible right now: count, long_usd, short_usd and window_minutes. A timing series, market-wide totals run higher. |