> ## Documentation Index
> Fetch the complete documentation index at: https://shumi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Shumi: AI crypto research assistant

> Ask Shumi about crypto markets on the web, in the terminal, over the API or from an AI agent.

Shumi answers questions about crypto markets using live data: trend, funding, sentiment, narratives and market breadth. It covers spot markets and perpetual futures on 17 exchanges, led by Binance, Hyperliquid, Bitget, OKX and Bybit, plus the perp DEXes Aster, Variational and Lighter. See [full coverage](https://shumi.mintlify.site/platform/coverage.md).

## Ways to use Shumi

> [card] [Web](https://shumi.ai/app)
>
> Ask on the shumi.ai homepage, or use the full chat at shumi.ai/app. Your first question needs no account.

> [card] [Terminal](https://shumi.mintlify.site/agents/cli.md)
>
> `npm install -g shumi`, then `shumi login`. Needs Node 22 or later.

> [card] [HTTP API](https://shumi.mintlify.site/api-reference/introduction.md)
>
> Keys come from the CLI: install it, run `shumi login`, then `shumi keys create`. Then call `https://api.shumi.ai`.

> [card] [AI agent](https://shumi.mintlify.site/agents/mcp.md)
>
> Add `https://mcp.shumi.ai/mcp` as a connector in your MCP client.

Every one of these reads the same data, so you get the same numbers wherever you ask.

## Ask your first question

> [tab] On the web
>
> **1. Open shumi.ai**
>
> Go to [shumi.ai](https://shumi.ai). You can ask your first question without an account.
>
> **2. Type a question and send it**
>
> Type in the **Ask a market question** box, for example "is BTC funding crowded?", and click **Run query**. Shumi fetches the data and writes the answer.
>
> **3. Continue in the full app**
>
> Under the answer, click **Continue in app** (or **Open app** next to the box). On [shumi.ai/app](https://shumi.ai/app), sign in with your email or a crypto wallet. A free account gets 10 questions, then 1 per day.

> [tab] In the terminal
>
> **1. Install the Shumi CLI**
>
> Needs Node 22 or later.
>
> ```bash theme={"dark"}
> npm install -g shumi
> ```
>
> **2. Sign in**
>
> ```bash theme={"dark"}
> shumi login
> ```
>
> **3. Get Shumi's verdict on a coin**
>
> ```bash theme={"dark"}
> shumi BTC
> ```
>
> You get a verdict from bullish to bearish, the evidence behind it and its coverage: how many of its inputs answered. It is scored from trend, funding and sentiment.
>
> **4. Ask a question in plain words**
>
> ```bash theme={"dark"}
> shumi ask "is BTC funding crowded?"
> ```

To use Shumi from your own code or an AI agent, see the [API Quickstart](https://shumi.mintlify.site/quickstart.md).

## Terminal commands to try

| You want to know | Command | Read more |
| - | - | - |
| What is Shumi's verdict on this coin? | `shumi signal SOL` | [Signals](https://shumi.mintlify.site/trade-decisions/signals.md) |
| How many coins are trending up, sideways or down? | `shumi market health` | [Market State](https://shumi.mintlify.site/research/market-health.md) |
| Where is funding crowded? | `shumi funding momentum` | [Funding](https://shumi.mintlify.site/trade-decisions/funding-momentum.md) |
| Which coins match my filters? | `shumi scan` | [Market Screener](https://shumi.mintlify.site/research/market-screener.md) |
| Which pairs could I trade against each other? | `shumi pairs suggestions` | [Pairs and Delta Neutral](https://shumi.mintlify.site/trade-decisions/pair-trading.md) |
| Anything else, in plain words | `shumi ask "…"` | [Shumi Chat](https://shumi.mintlify.site/research/shumi-chat.md) |

On the web, ask any of these as a normal question.

## Plans

> [tab] Subscription
>
> | Plan | Price | What you get |
> | - | - | - |
> | Free | Free | 10 questions to start, then 1 per day |
> | Plus | \$20 / month | 50 per day |
> | Pro | \$200 / month | No limit |
> | Genesis | \$500 once | Same as Pro, for life |
>
> On the free plan, each terminal or API command also counts as one question. The daily question resets at 00:00 UTC. The first 10 never refill. [Plans and Quotas](https://shumi.mintlify.site/platform/access.md) has the details.

> [tab] Pay per call
>
> Fund a wallet with USDC on Base, and each API call pays for itself: 0.005 USDC for a data call, 0.05 for a question, `pairs` or `walkforward`. A call that fails on our side is not charged. [Pay Per Call](https://shumi.mintlify.site/agents/payments.md) has the setup.

## Check the data and the method

> [card] [How fresh is the data?](https://shumi.mintlify.site/platform/coverage.md#how-fresh-the-data-is)
>
> Most responses show their age: `shumi signal BTC --agent | jq .meta.data_age_seconds`. Check it before you act on a funding rate or a price.

> [card] [Published studies](https://shumi.mintlify.site/evidence/studies.md)
>
> The strategy studies list every closed trade with its dates, prices and return, losses included. The benchmark lists every score.

## CoinRotator

[coinrotator.app](https://coinrotator.app) is the screener. It applies fixed rules to the market data, so the same data always gives the same trend, streak and ranking. Shumi reads that data together with funding, sentiment and narratives, and weighs them into an answer. When an answer names a coin, it links to that coin's page on coinrotator.app, so you can see the numbers it started from.


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