scan_market_regimes
Screen a crypto perpetual futures venue by market regime — trending up/down, ranging or volatile — and get each matching coin with confidence, ADX, trend strength, volatility ratio and regime age.
Instructions
Screens a whole crypto perpetual futures venue by market regime — TRENDING_UP TRENDING_DOWN RANGING VOLATILE — and returns each matching coin with confidence, trend strength, ADX, volatility ratio and how long the regime has held. Rows are the market regime classifier output for the last closed bar, sampled on Binance, Bybit, OKX and Bitget; another venue, or a timeframe a venue cannot serve, is refused with the alternatives. Billing: one call per returned row; non-matching coins are free. For a live single-coin read with cross-venue funding, call get_market_regime. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topN | No | Lens universe size, 1 to 1000 (default 100 with rankBy). Without rankBy it selects the top coins by open interest. | |
| coins | No | Restrict to these symbols, e.g. ["BTC","ETH"]. Symbols not on the venue are listed in not_found and not billed. | |
| limit | No | Page size, 1 to 100 (default 20). | |
| offset | No | Rows to skip, for paging within one snapshot. A changed as_of means the snapshot advanced between pages. | |
| rankBy | No | Optional universe lens — the same lenses and aliases as scan_trade_calls rankBy; rows then echo the lens metric. Omit to screen every coin. | |
| regime | No | Keep only these regimes (any of): TRENDING_UP, TRENDING_DOWN, RANGING, VOLATILE. | |
| sortBy | No | confidence (default), regime_age (most recent regime change first, unknown starts last), or rank (lens order; needs rankBy). | confidence |
| oiBasis | No | OI-delta basis for rankBy=oi_change: notional (default, USD) or contracts (base-coin, price-independent). Ignored by other lenses. | notional |
| exchange | No | Venue to screen (default Binance). A venue outside the sampled set is refused with the sampled list. | BINANCE |
| timeframe | No | Regime timeframe: 1h, 4h or 1d (default 4h). | 4h |
| assetClass | No | all (default), crypto, tradfi (every non-crypto class), equity, commodity, index, fx or premarket. | all |
| minConfidence | No | Optional confidence floor, 0 to 100. | |
| oiChangeWindow | No | OI-delta window for rankBy=oi_change: 1h, 4h, or 24h (default 24h). Ignored by other lenses. | 24h |
| minLiquidityUsd | No | Optional USD liquidity floor applied to the scan universe: notional open interest, or 24h volume on venues that expose no bulk OI. Omitted means no floor. | |
| maxRegimeAgeBars | No | Keep only coins whose regime began within this many bars (1 = changed on the last closed bar). Coins whose regime start is not yet known are excluded. |