Quickstart - Shumi Docs

Pick the surface you actually want. All three hit the same API and return the same data.

From the terminal

npm install -g shumi
shumi login
shumi BTC

That is the whole setup. A bare ticker returns a signal; shumi ask "…" runs the full pipeline. Node 22+ required. More in CLI.

From HTTP

You need a key. Mint one from the CLI:

shumi keys create

Then:

curl "https://api.shumi.ai/api/cli/signal/BTC" \
  -H "Authorization: Bearer shumi_sk_your_key_here"

Every typed response comes back in the same envelope:

{
  "schemaVersion": 1,
  "data": { "…": "…" },
  "meta": { "ts": "…", "as_of": "…", "data_age_seconds": 163 }
}

Read meta.data_age_seconds before you act on anything time-sensitive. A funding rate is a different input at forty seconds old than at forty minutes. Full contract in API Overview.

From an agent

Add the MCP server to Claude Code:

claude mcp add shumi \
  --env SHUMI_TOKEN=shumi_sk_your_key_here \
  -- npx -y @shumi-ai/mcp

Restart the client and 31 read-only tools appear. Claude Desktop and Cursor use a JSON config instead, both shown in MCP Server, along with a hosted endpoint if your client cannot spawn a local process.

What to try first

Question	Command
Is this coin trending?	`shumi signal SOL`
What is the market doing?	`shumi market` / `shumi regime`
Where is funding crowded?	`shumi funding`
Find me candidates	`shumi scan`
Hedge a position I hold	`shumi pairs`
Anything, in words	`shumi ask "…"`

Before you rely on it

Two things worth knowing up front rather than discovering later:

Shumi does not trade. No order path, no exchange keys. Every output is an input to your decision.
Free is ten queries, then one a day. Not a daily allowance of ten. Access and Quotas explains the counter, and the $SHUMI hold path if you would rather not subscribe.

If you want to judge the method before trusting the output, Evidence has five studies with the ledgers and the failures included.

​From the terminal

​From HTTP

​From an agent

​What to try first

​Before you rely on it

From the terminal

From HTTP

From an agent

What to try first

Before you rely on it