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

# Coin Lookup

> Price, market cap, trend history and the risk picture for one coin, and the same for a stock or commodity.

Look up one coin by ticker, name, id or contract address and get its price, market cap, supply, trend history and perpetual funding. On the web, ask in chat: "tell me about SOL".

## Find the coin

<Tabs>
  <Tab title="Terminal">
    ```bash theme={"dark"}
    shumi coin lookup SOL
    shumi coin by-name Solana
    shumi coin by-id solana
    shumi coin by-contract 0xdAC17F958D2ee523a2206206994597C13D831ec7 --chain ethereum
    ```

    A contract address needs `--chain` (ethereum, bsc, solana, base and others).
  </Tab>

  <Tab title="API">
    ```bash theme={"dark"}
    curl "https://api.shumi.ai/api/cli/coin/lookup?symbol=SOL" \
      -H "Authorization: Bearer shumi_sk_your_key_here"
    ```

    Also `/api/cli/coin/by-name/{name}`, `/api/cli/coin/by-id/{id}` and `/api/cli/coin/by-contract/{address}?chain=ethereum`.
  </Tab>

  <Tab title="AI agent">
    Use the `lookup_coin` tool with `by` set to `symbol`, `name`, `id` or `contract`.
  </Tab>
</Tabs>

## Read the current trend

`currentTrend` is the coin's daily trend now. `shumi coin lookup SOL` prints it on its first line:

```
  current trend  UP since 2026-09-19 (8 days, as of 2026-09-26)
```

In JSON:

```json theme={"dark"}
"currentTrend": {
  "trend": "UP",
  "since": "2026-09-19",
  "days": 8,
  "asOf": "2026-09-26",
  "incompleteDayExcluded": false,
  "awaitingDailyUpdate": false,
  "legsIncomplete": false
}
```

| Field | Meaning |
| - | - |
| `trend` | `UP`, `DOWN` or `HODL` |
| `since`, `days` | The day the trend started, and how many days from `since` to `asOf`, both counted |
| `asOf` | The last complete day the trend is measured on |
| `incompleteDayExcluded`, `awaitingDailyUpdate` | `true` between 00:00 and 03:00 UTC while today's trend is still being built. The value shown is yesterday's |
| `legsIncomplete` | `true` when the newest day was built from less data than usual. Treat the trend as provisional |

The daily trend updates shortly after 00:00 UTC. With both update flags `false` and `since` equal to today, the trend flipped today. `currentTrend` is `null` when the coin has no recent trend data. It needs CLI 0.9.0 or later.

## Read price, supply and trend history

`trends` is the history of trend runs, oldest first. `coin.deltas` gives the 4h, 24h and 7d moves.

| Field | Meaning |
| - | - |
| `coin.currentPrice`, `coin.priceSource` | Latest price and the exchange it came from |
| `coin.marketCap`, `coin.circulatingSupply`, `coin.totalSupply` | Size and supply |
| `coin.ath`, `coin.atl` | All-time high and low |
| `coin.deltas` | Price change over 4h, 24h and 7d, in percent |
| `coin.futuresData` | Open interest, 24h futures volume and funding APR on the perpetual |
| `trends` | Daily trend runs, each UP, DOWN or HODL (the coin's trend disagrees across quote currencies, so it counts as sideways), with `start`, `end` and `streak` in days |

## Get the risk picture in one call

```bash theme={"dark"}
shumi coin risk SOL
```

`shumi coin risk BTC ETH SOL` returns a list, with shorter field names. Over the API: `/api/cli/coin/risk/{symbol}`. In an agent: `get_coin_risk`.

| Field | Meaning |
| - | - |
| `price`, `price_source`, `price_as_of` | Latest price, where from, when |
| `funding_rate`, `funding_interval_hours` | Funding per interval, in percent, and the interval length |
| `funding_apr` | The same rate as a yearly percentage |
| `funding_paying_side` | `longs` or `shorts`: who pays right now |
| `carry_if_long`, `carry_if_short` | What a perpetual position pays or receives, as a sentence |
| `trend_daily`, `trend_weekly` | `bullish` or `bearish`, with `trend_daily_since` and `trend_weekly_since` |
| `sentiment_stance`, `sentiment_summary` | The crowd's stance, such as `accumulation`, and a one-line summary. `null` when Shumi has no read on the coin |
| `btc_correlation` | How closely the coin moves with BTC (DOGE 0.8). `null` for BTC itself |

Funding applies to perpetual positions only.

## When a ticker names two assets

Some tickers belong to a coin and to a stock or commodity. `shumi resolve GOLD` returns both:

```json theme={"dark"}
"matches": [
  {"id": "cyberdragon-gold", "name": "CyberDragon Gold", "assetType": "crypto"},
  {"id": "xyz:GOLD", "name": "GOLD", "assetType": "commodity"}
]
```

Coin commands take the crypto match. For the metal, use `shumi commodity GOLD`.

`resolve` matches the ticker first and the name only when no ticker matches. So `shumi resolve Ethereum` finds a token whose ticker is `ethereum`. Pass `ETH` instead, or look up a name with `shumi coin by-name Ethereum`.

Over the API: `/api/cli/resolve?q=GOLD`. In an agent: `resolve_coin`.

## Look up a stock or commodity

```bash theme={"dark"}
shumi stock AAPL
shumi commodity GOLD
```

Both return the asset's price, its trend and the funding on the perpetual that tracks it.

| Field | Meaning |
| - | - |
| `price`, `priceAsOf` | Latest price and when it was taken |
| `trend.daily`, `trend.weekly` | `UP`, `DOWN` or `HODL` on the daily and weekly chart |
| `funding.apr` | Funding on the perpetual, as a yearly percentage. The stock or metal itself pays none |
| `funding.openInterest` | Open interest on the perpetual |
| `funding.markPx` | The perpetual's mark price |

| Where | How |
| - | - |
| API | `GET /api/cli/rwa/symbol/{symbol}` |
| AI agent | `get_rwa_asset` |
| Every asset | `shumi rwa list` prints the first 200. `GET /api/cli/rwa/assets?top=1000` returns all of them. [Coverage](/platform/coverage#real-world-assets-rwa) lists the venues |


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