# Shumi Docs

> Shumi docs: ask crypto market questions on the web, in the terminal, over the API or from an AI agent.

- [Shumi: AI crypto research assistant](https://shumi.mintlify.app/index.md): Ask Shumi about crypto markets on the web, in the terminal, over the API or from an AI agent.
- [Shumi: AI crypto research assistant](https://shumi.mintlify.app/index.md): Ask Shumi about crypto markets on the web, in the terminal, over the API or from an AI agent.
- [Shumi Chat](https://shumi.mintlify.app/research/shumi-chat.md): Ask about any coin, sector, narrative or the whole market, and get one read that weighs trend, funding, sentiment and positioning together.
- [Shumi Chat](https://shumi.mintlify.app/research/shumi-chat.md): Ask about any coin, sector, narrative or the whole market, and get one read that weighs trend, funding, sentiment and positioning together.
- [Coin Lookup](https://shumi.mintlify.app/research/coin-analysis.md): Price, market cap, trend history and the risk picture for one coin, and the same for a stock or commodity.
- [Market Screener](https://shumi.mintlify.app/research/market-screener.md): Rank the day's biggest movers, or filter the tracked coins by trend, category and market cap.
- [CoinRotator: free crypto trend screener](https://shumi.mintlify.app/coinrotator.md): The rule-based crypto screener at coinrotator.app, and how Shumi links to it.
- [Signals](https://shumi.mintlify.app/trade-decisions/signals.md): One verdict per coin, from bullish to bearish, with the evidence behind it and its coverage.
- [Signals](https://shumi.mintlify.app/trade-decisions/signals.md): One verdict per coin, from bullish to bearish, with the evidence behind it and its coverage.
- [Market State](https://shumi.mintlify.app/research/market-health.md): How many coins are trending up, sideways or down, whether the market has flipped, BTC dominance, and the regime engine's trade log.
- [Funding](https://shumi.mintlify.app/trade-decisions/funding-momentum.md): Perp funding per coin as an APR, ranked against every perp in the market, plus market temperature and funding alerts.
- [Pairs and Delta Neutral](https://shumi.mintlify.app/trade-decisions/pair-trading.md): Long one coin against another, or the same coin long on one venue and short on another to collect the funding gap.
- [Sentiment and Narratives](https://shumi.mintlify.app/research/sentiment.md): The crowd's read on a coin or the market, which categories are heating up, and which narratives are active.
- [Shumi API and MCP server quickstart](https://shumi.mintlify.app/quickstart.md): Get an API key, call the Shumi API from your own code, and add the MCP server to your AI agent.
- [Shumi API and MCP server quickstart](https://shumi.mintlify.app/quickstart.md): Get an API key, call the Shumi API from your own code, and add the MCP server to your AI agent.
- [API Overview](https://shumi.mintlify.app/api-reference/introduction.md): Base URL, authentication, the response envelope, error codes and quotas for the Shumi API.
- [CLI](https://shumi.mintlify.app/agents/cli.md): Install the shumi command, sign in, create API keys and pull market data into scripts and agents.
- [MCP Server](https://shumi.mintlify.app/agents/mcp.md): Give an AI agent Shumi's market data as MCP tools, hosted or run locally.
- [Pay Per Call](https://shumi.mintlify.app/agents/payments.md): Pay for single API calls in USDC on Base with the x402 protocol, with no subscription.
- [Ask a natural-language question](https://shumi.mintlify.app/api-reference/ask/ask-a-natural-language-question.md): Answers a question in plain words. Shumi picks the data the question needs, fetches it and writes the answer. Paid per call, it costs 0.05 USDC.
- [Verdict for one coin](https://shumi.mintlify.app/api-reference/trade-decisions/verdict-for-one-coin.md): A verdict for one coin, with its evidence. `coverage` (`high`, `medium` or `low`) says how many of the four inputs (trend, funding, sentiment, regime) answered. `confidence` carries the same value.
- [Market regime](https://shumi.mintlify.app/api-reference/trade-decisions/market-regime.md)
- [Perpetual funding momentum](https://shumi.mintlify.app/api-reference/trade-decisions/perpetual-funding-momentum.md): Market-wide when `symbol` is omitted, otherwise scoped to one asset.
- [Recent funding alert events](https://shumi.mintlify.app/api-reference/trade-decisions/recent-funding-alert-events.md)
- [Futures signals](https://shumi.mintlify.app/api-reference/trade-decisions/futures-signals.md)
- [Pair trading and delta-neutral](https://shumi.mintlify.app/api-reference/trade-decisions/pair-trading-and-delta-neutral.md): `suggestions` pairs two different coins. `delta-neutral` is the same coin across two venues, earning the funding spread. They are not interchangeable.
- [Trend state across the market](https://shumi.mintlify.app/api-reference/trade-decisions/trend-state-across-the-market.md)
- [Signal track record](https://shumi.mintlify.app/api-reference/trade-decisions/signal-track-record.md): The forward-tested record of Shumi's signals: the signals, the positions they opened and their outcomes.
- [Signal quality scoring](https://shumi.mintlify.app/api-reference/trade-decisions/signal-quality-scoring.md)
- [Resolve free text to an asset](https://shumi.mintlify.app/api-reference/coins/resolve-free-text-to-an-asset.md): Searches coins and real-world assets and returns ranked matches, each tagged with how it was found. Use it for a ticker that names both a coin and a real-world asset, such as `GOLD` or `COIN`.
- [Look up a coin by ticker](https://shumi.mintlify.app/api-reference/coins/look-up-a-coin-by-ticker.md): Returns coin metadata and trend state. If the ticker also matches a real-world asset, the response carries a `note` naming the collision.
- [Bundled risk context](https://shumi.mintlify.app/api-reference/coins/bundled-risk-context.md): Price, funding, trend alignment, sentiment stance, and BTC correlation in one payload. Fields that could not be refreshed are listed in `_stale_fields`.
- [Crowd sentiment for one coin](https://shumi.mintlify.app/api-reference/coins/crowd-sentiment-for-one-coin.md)
- [Historical metadata](https://shumi.mintlify.app/api-reference/coins/historical-metadata.md)
- [Resolve a contract address to a coin](https://shumi.mintlify.app/api-reference/coins/resolve-a-contract-address-to-a-coin.md)
- [Coin by canonical id](https://shumi.mintlify.app/api-reference/coins/coin-by-canonical-id.md)
- [Coin by display name](https://shumi.mintlify.app/api-reference/coins/coin-by-display-name.md)
- [Live prices](https://shumi.mintlify.app/api-reference/market/live-prices.md): Keyed by ticker.
- [Global market snapshot](https://shumi.mintlify.app/api-reference/market/global-market-snapshot.md)
- [Breadth crossings](https://shumi.mintlify.app/api-reference/market/breadth-crossings.md): Returns a `crossings` array, empty when nothing has fired.
- [Market breadth and health](https://shumi.mintlify.app/api-reference/market/market-breadth-and-health.md)
- [Reference baselines](https://shumi.mintlify.app/api-reference/market/reference-baselines.md)
- [Filterable market screener](https://shumi.mintlify.app/api-reference/market/filterable-market-screener.md)
- [All categories](https://shumi.mintlify.app/api-reference/categories/all-categories.md)
- [Category trend breakdown](https://shumi.mintlify.app/api-reference/categories/category-trend-breakdown.md)
- [Coins in a category](https://shumi.mintlify.app/api-reference/categories/coins-in-a-category.md)
- [Sentiment for a category](https://shumi.mintlify.app/api-reference/categories/sentiment-for-a-category.md)
- [Sentiment and narrative momentum](https://shumi.mintlify.app/api-reference/sentiment/sentiment-and-narrative-momentum.md)
- [Active narratives](https://shumi.mintlify.app/api-reference/sentiment/active-narratives.md)
- [Tracked token holder counts](https://shumi.mintlify.app/api-reference/tracking/tracked-token-holder-counts.md)
- [Tracked wallet activity](https://shumi.mintlify.app/api-reference/tracking/tracked-wallet-activity.md)
- [Highlights mined from tracked transcripts](https://shumi.mintlify.app/api-reference/tracking/highlights-mined-from-tracked-transcripts.md): Spoken-word commentary from tracked video and podcast sources, tagged with the coins, sectors, and macro topics mentioned.
- [Tracked basket snapshots](https://shumi.mintlify.app/api-reference/tracking/tracked-basket-snapshots.md)
- [Token unlocks for one coin](https://shumi.mintlify.app/api-reference/unlocks/token-unlocks-for-one-coin.md): The next unlock: date, tokens, US dollar value, share of market cap and recipients. Also what releases over the next 30 and 90 days, how much is unlocked so far, and how price moved in the 7 days around past unlocks. `state` is `upcoming`, `fully_unlocked`, `no_unlock_data` or `not_covered`. Every f…
- [Upcoming unlocks across the market](https://shumi.mintlify.app/api-reference/unlocks/upcoming-unlocks-across-the-market.md): Each row has the date, coin, tokens, US dollar value, share of market cap, recipients and the team and investor share. Ranked by share of market cap unless `sort` says otherwise.
- [List real-world assets](https://shumi.mintlify.app/api-reference/rwa/list-real-world-assets.md): Stocks, ETFs, metals, commodities, indices and FX that trade as perps.
- [One real-world asset](https://shumi.mintlify.app/api-reference/rwa/one-real-world-asset.md)
- [Real-world asset by ticker](https://shumi.mintlify.app/api-reference/rwa/real-world-asset-by-ticker.md)
- [Stream updates as NDJSON](https://shumi.mintlify.app/api-reference/streaming/stream-updates-as-ndjson.md): Newline-delimited JSON, one object per line, sent every `interval` seconds until the client disconnects. Opening a stream counts against your quota. Streams cannot be paid per call, so a spent quota answers 429.
- [Your plan](https://shumi.mintlify.app/api-reference/account/your-plan.md): The plan the API applies to this token. Free, and works when your quota is spent.
- [Shumi plans, pricing and question quotas](https://shumi.mintlify.app/platform/access.md): What each plan gives you, how the free counter works, and what you see when it runs out.
- [Shumi plans, pricing and question quotas](https://shumi.mintlify.app/platform/access.md): What each plan gives you, how the free counter works, and what you see when it runs out.
- [Coverage](https://shumi.mintlify.app/platform/coverage.md): What you can look up with Shumi: any listed coin, any token with a DEX pool, perps on 17 exchanges, and real-world assets (RWA).
- [Shumi evidence: studies, backtests and decision record](https://shumi.mintlify.app/evidence/studies.md): Shumi's published studies, dated readings, the walk-forward record and the decision record.
- [Decision record](https://shumi.mintlify.app/evidence/decision-record.md): One Shumi take a day, published verbatim with its inputs' times, scored later by rules fixed before the first entry.
- [Decision record: rules](https://shumi.mintlify.app/evidence/pre-registration.md): Version 2 of the rules behind the public decision record: the coin pick, the daily question, the scoring of each plan and the pass bar.
- [Decision record: rules, version 1](https://shumi.mintlify.app/evidence/pre-registration-v1.md): The rules of the decision record as registered on 2026-10-14, kept unchanged. Superseded on 2026-10-29 by version 2.
- [FAQ](https://shumi.mintlify.app/platform/faq.md): Short answers to the questions traders ask most about Shumi.
- [Changelog](https://shumi.mintlify.app/platform/changelog.md): Updates to Shumi Chat, the CLI, the API and CoinRotator.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.