get_screener
Screen cryptocurrencies by market cap, volume, and sort by metrics such as volatility or price change. Get filtered results for trading analysis.
Instructions
Get cryptocurrency screener results. Filter by market cap, volume, and sort by various metrics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | Field selection: preset ("minimal", "standard", "extended", "full") or comma-separated fields (e.g. "_id,uuid,settings.name,profit.total"). Default: "standard" | |
| page | No | Page number for pagination (1-based). Default: 1 | |
| category | No | Filter by category (optional) | |
| minMarketCap | No | Minimum market cap (optional) | |
| maxMarketCap | No | Maximum market cap (optional) | |
| minVolume | No | Minimum volume (optional) | |
| sort | No | Sort field (applied client-side; the API does not sort). One of: "volatility" (largest absolute 24h % change), "priceChange"/"change", "volume"/"totalVolume", "marketCap", "price". Use "volatility" to find the most volatile pairs. | |
| order | No | Sort order (optional, default desc when sorting) | |
| maxPages | No | When sorting, how many pages (10 coins each, ≤30, default 10) to fetch and rank across. Higher = wider pool for "most volatile" but more requests. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | OK on success, NOTOK on a handled API error. | |
| reason | No | Error reason when status is NOTOK; null otherwise. | |
| data | No | Screener rows (coins) with market data. When `sort` is used, ranked client-side and `meta` records the sort details. | |
| meta | No | Pagination / result metadata, present on list-style responses. |