CLI

Market overview with BTC/ETH prices and changes, total market cap and volume, BTC dominance, Fear and Greed Index, and the ETH/BTC ratio.

The market briefing report from GET /v1/briefing, printed as the endpoint renders it: market stats, the API's narrative ranking by 24h change, its funding extremes by 8h-equivalent rate among fresh markets with at least $1M of open interest (shown as APR), and the whole-market funding estimated over the next 24 hours, ending with the freshness of every answer the report read. The same bytes as the MCP tool market_briefing; --json prints the report object (report_md and the reads it was composed from).

One coin's analysis report from GET /v1/coins/{coin}/analysis, printed as the endpoint renders it: the price prediction, the coin's funding by market with the API's average and median, its open-interest total and the next 24h settlement estimate. The same bytes as the MCP tool analyze_coin; --json prints the report object.

The funding-arbitrage report from GET /v1/opportunities, printed as the endpoint renders it: the top spot-perp and cross-exchange trades among markets with at least $1M of open interest, in the API's board order, and the market's funding stats. The same bytes as the MCP tool find_opportunities; --json prints the report object.

Live auto-refresh mode. Clears the screen and re-fetches data every 30 seconds (configurable with --interval). Supports market, funding, futures, and arb as targets. Use --chart, --coin, and --type for watched derivatives or arbitrage views.

Asset correlation matrix over 30d, 90d, 1y, or 3y with --period, optionally filtered with comma-separated canonical coin IDs via --ids.

Market heatmap data for coins, narratives, or ecosystems via --mode, with an optional --category filter.

Funding rates across 32 perpetual exchanges, covering crypto plus tokenized equity, commodity, index and FX perps. Every row carries asset_class and margin_type; current and accumulated rows also carry asset_id, lot_multiplier, instrument_status and is_live. Use --type to select current (default), accumulated, or history. --coin filters to one coin in any mode: every contract of the asset, lot spellings such as 1000PEPE included, exactly as the API scopes it. --sort FIELD reorders rows (prefix with - for descending; common fields: rate, rate_8h, apr, base_coin, exchange, open_interest, next_funding_time); with the current type, open_interest and -open_interest are applied by the API before its page. Sorting by a field no row carries leaves the order untouched and prints a note on stderr. --limit N keeps only the first N rows after filter/sort. --exchange, --asset-class and --margin filter the book; --page-size N and --cursor page it on the API. History mode also accepts --days. rate is a fraction charged once per interval_hours, which varies by contract (1h, 2h, 4h, 8h or 24h). It is not a percentage; current rows also carry rate_8h and apr. Instead of rows, the current type answers the API's aggregates: --extremes N (the N highest and lowest markets by 8h-equivalent rate, floored with --min-oi-usd), --stats (the whole book's mean and OI-weighted funding APR and the positive/negative counts) and --summary with --coin (the coin's average and median 8h funding across venues). Accumulated rows show each window's sum with its coverage beside it: (complete), (incomplete 56%) or (not expected), and the windows the contract was listed or halted in; compare sums only on complete windows.

Dollar value of funding actually paid at each settlement, and which side paid it -- not just the rate. Use --window to select current (default; the next 24 hours at current rates, priced live and always estimated), 1d, 3d, or 7d (realised; one below 90% coverage is still building history). --class selects all (default), crypto, or rwa. --coin and --exchange filter rows. net is long_paid minus short_paid: positive is a cost to longs, negative means shorts paid. --limit N caps rows returned and --offset N pages them; --sort FIELD orders them by base_coin, net, long_paid, short_paid or open_interest_usd (prefix - for descending); --expand venues adds each row's per-venue breakdown to the JSON. Each row shows the window's partial, complete and halted_within_window flags.

Whole-market derivatives board across crypto perps and every RWA perp class. Use --tab to select crypto (default), equity, preipo, etf, index, commodity or fx. The market-wide metric line is identical on every tab. Supports --sort and --limit like funding.

RWA-perp funding and carry (stocks, pre-IPO, ETFs, indices, commodities) across 19 venues. Use --type to select current (default), history (requires --symbol; accepts --days), or stats (best carry, top spread, weekend premium). --venue filters to one venue. Supports --sort and --limit like funding.

Futures chart data. The first argument is the chart ID: oi-stacked, liquidations, funding-rate, annualized-basis, volume-history, long-short-ratio, and more. Accepts --coin, --timeframe, and --exchanges; --limit and --cursor page the raw rows oldest-first. Without --limit, oi-snapshot shows each exchange's latest reading.

Derivatives market overview: total open interest, OI-weighted funding, and the top coins by OI across exchanges.

Arbitrage opportunities. Pass spot-perp (default), cross-exchange, dated-basis, calendar-spread, perp-dated, or spot-transfer as the first argument. Rows are sorted by the product's primary net return field by default; override with --sort FIELD (prefix with - for descending). Filter spot-perp rows with --exchange, --direction and --min-oi-usd (the perp leg's open interest, applied by the API); filter cross-exchange rows with --exchanges, --asset-class, --sector (memes, ai-agents, layer-1, defi), --min-oi-usd, --min-vol-usd and --limit; filter futures scanners with --coin, --exchanges, --min-apr, --min-oi-usd, --min-volume-usd, --min-depth-usd, --margin-type, --notional, --limit and --cursor. borrow lists margin borrow rates per coin (Binance, OKX, Bybit, Gate.io; --coin, --exchanges), one row per coin with the cheapest venue first and each venue's annual rate as a fraction. history backtests one pair's funding carry from stored settlements: --mode spot-perp with --venue (--contract, --direction), or --mode cross-exchange with --long-venue and --short-venue (--long-contract, --short-contract), and --days (1-90); it prints one row per backtest window, the legs and fees on stderr. boros compares Pendle Boros fixed funding with realised 7D and 30D funding for the same venue contract (--coin, --venue), one row per Boros market with the spread implied − realised as a fraction; a missing realised figure stays empty with its reason. An option the chosen board does not take is left out with a note on stderr.

Crypto narrative analytics covering L1, DeFi, AI, RWA, Memes, and 25 more sectors. Use --slug (or --narrative) to drill into a single narrative. --sort -change24h (or change24h) orders the list by 24h change, and --top N / --bottom N show the API's N highest and lowest narratives by 24h change. --correlation adds the correlation matrix of the narrative's tokens over --timeframe.

Blockchain ecosystem analytics for Ethereum, Solana, Base, Arbitrum, and 19 more chains. Use --slug (or --ecosystem) to drill in and --exclude-native to remove the native token from aggregates. --correlation adds the correlation matrix of the ecosystem's tokens over --timeframe.

Memecoin narrative intelligence across grouped aggregate, theme, chain, and launchpad categories. Use --slug (or --narrative) for a single narrative such as dog-coins, cat-coins, ai-memes, or trump-coins; --historical supports 24h, 7d, 30d, and 1y; --coin-history adds top-coin price history in detail mode. Reorder with --sort FIELD (prefix with - for descending; common fields: marketCap, change24h, momentum, coinCount) and cap with --limit N.

Recently launched memecoin pairs screened by launch age, liquidity, volume, transactions, and profile. Supports --chains, --days, --limit, --profile, and --sort FIELD.

New listings tagged by narrative. First argument is the mode: hub (default, its recent listings as the table; --json for the weekly and monthly buckets), recent, events, or exchanges. Supports --narrative, --exchange, --venue-type, --market-type, --event-type, --asset-class, --status, --confidence, --from, --to, --days, --limit, --cursor, and --sort FIELD. Exchanges mode also supports --enabled. An option the chosen mode does not take is left out with a note on stderr.

Stablecoin supply at peg, marked value, peg model, mechanism, chain supply, coverage, detail, and yield data. Use --type overview, --type detail --slug usdt, or --type yields.

Read-only token scanner modes selected with --mode: hot, new-runners, alpha-drops, ai-top, and top-new. Filter with --chains or --chain, choose --profile, cap with --limit (1 to 72), apply liquidity/flow gates with --min-liquidity-usd, --min-volume-h24, --min-txns-h1, --min-txns-h24, and --min-price-change-h1. Control the observation window and age with --days, --max-age-hours, and --include-unknown-age; use --sort-by, --min-breakout-readiness, --min-relative-strength, and --max-vol-liq-ratio for opportunity ranking.

Rug Check trending tokens or token security lookup. Use rug-check trending --limit N or rug-check security --address ... --chain-id ....

Search crypto and supported TradFi assets by name or ticker. The first argument is the query string.

Market-ranked token screening. Scope to one chain with --chain (e.g. solana, base). Use --limit to control page size (default 20) and --cursor to continue from the snapshot-bound cursor printed by the previous page. Reorder with --sort FIELD (prefix with - for descending; common fields: volume24h, marketCap, change24h, athDistance).

Deterministic directional scores and optional heuristic scenarios. Pass --coin with a ticker or canonical coin slug (e.g. BTC, bitcoin).

Aggregated crypto news feed. Supports --limit, --offset, --coin, --category, and --since (ISO 8601 timestamp) filters. Use --query/-q to search titles across the stored corpus. Reorder with --sort FIELD (prefix with - for descending; common fields: published, source).

Narrative mindshare rankings, token rows, rolling windows, and historical snapshots. Use --tokens, --narrative, --historical, --timeframe, and --window to choose the payload.

Attention rankings, social snapshots, and market-level signals. Use --type, --mode, --tf, --entities, and --sub to select entity, payload, timeframe, IDs, and market sub-mode.

Insider selling pressure signals across crypto assets, filterable with --min-score and capped with --limit. --coin returns one coin's row by its CoinGecko id, as the scorer wrote it.

Pump-and-dump manipulation risk signals across crypto assets, filterable with --min-score, scoped to a lifecycle --phase (setup, markup, distribution, dump, dumping), and capped with --limit. --coin returns one coin's row by its CoinGecko id, as the scorer wrote it.

Self-diagnosis: checks CLI version, Python version, config file, API key status, network connectivity to both free and authenticated endpoints, and terminal environment.

Interactive authentication flow. Opens the Sharpe API key dashboard in your browser, prompts you to paste your API key, validates it against the API, and saves it to the config file.

Lists all available data products, supported exchanges, chart types, and coin coverage.

Lists available futures coins with per-exchange capability flags.

Your Sharpe API key from the API key dashboard. Overridden by the SHARPE_API_KEY environment variable.

Default coin for commands that accept --coin. Defaults to BTC. Overridden by the SHARPE_DEFAULT_COIN environment variable.

Default timeframe for futures commands. Defaults to 3M. Valid values: 1W, 2W, 1M, 3M, 6M, 1Y, 3Y, ALL. Overridden by the SHARPE_DEFAULT_TIMEFRAME environment variable.

API key for authenticated /api/v1/* requests. Overrides api_key in the config file.

Site root for authenticated API calls. Defaults to https://www.sharpe.ai; legacy /api or /api/v1 base values are normalized.

Site root for free public API fallback calls. Defaults to https://www.sharpe.ai; legacy /api base values are normalized.

Default coin for commands that accept --coin. Overrides default_coin in the config file.

Default timeframe for futures and watch-mode chart calls. Overrides default_timeframe in the config file.

Set to 1 to disable the once-per-day package update check.