> For the complete documentation index, see [llms.txt](https://mute-sh.gitbook.io/mute.sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mute-sh.gitbook.io/mute.sh/api/getting-started/readme.md).

# Welcome

mute.sh is the data layer for **HIP-4 prediction markets on Hyperliquid**: every market, outcome, fill, trader, builder, and settlement — enriched, indexed, and served over REST + SSE at **`https://api.mute.sh`**.

Three products, one API key:

| Product                  | Endpoint                 | Use it for                                                                                        |
| ------------------------ | ------------------------ | ------------------------------------------------------------------------------------------------- |
| **Data API** (this book) | `https://api.mute.sh/v1` | markets, fills, portfolios, analytics, real-time SSE streams                                      |
| **gRPC block stream**    | `grpc.mute.sh`           | ultra-low-latency raw HyperEVM block headers + HyperCore block markers (Enterprise)               |
| **Webhooks**             | you receive `POST`s      | guaranteed delivery of fill/settlement events for watched wallets & builders (Scale & Enterprise) |

**New here?** [Read why raw data won't ship your app](/mute.sh/api/getting-started/why-not-raw-data.md) — the opaque coin codes, the trade-versus-plumbing traps, and the missing push layer that make raw HIP-4 data unusable on its own, and exactly what mute hands you instead.

## 60-second quickstart

No key needed to try it — anonymous requests get the free tier (10 req/min, 1,000 req/month, metered by IP):

```bash
curl "https://api.mute.sh/v1/markets/overview?underlying=BTC&period=1d"
```

```json
{
  "data": [
    {
      "coin": "#1541",
      "market_class": "priceBinary",
      "underlying": "BTC",
      "period": "1d",
      "target_price": 63927,
      "market_name": "Recurring",
      "trades": 69569,
      "traders": 300,
      "volume": 3495337.6,
      "avg_px": 0.678
    }
  ]
}
```

With a key (format `mute_<base62>`, from [app.mute.sh](https://app.mute.sh)) you get your plan's limits:

```bash
curl -H "X-API-Key: $MUTE_KEY" "https://api.mute.sh/v1/markets/overview"
```

Live fills as they happen, over SSE:

```bash
curl -N "https://api.mute.sh/v1/activity/stream?apikey=$MUTE_KEY&min_notional=1000"
```

## Reading HIP-4 data

Three conventions you'll see everywhere:

* **Coins are `#N` strings** (e.g. `#1541`) — each HIP-4 market is a Hyperliquid spot asset. Resolve human-readable names with [`GET /v1/markets/coin-labels`](/mute.sh/api/api-reference/markets.md#get-v1marketscoin-labels).
* **Prices are probabilities**: `px` is always in `(0, 1)` — a fill at `0.678` means the market priced that outcome at 67.8%.
* **Sizes are USD-denominated**: `px * sz` is the USD notional of a fill (all HIP-4 markets are USD-collateralized).

## Where to go next

* [Why not raw data?](/mute.sh/api/getting-started/why-not-raw-data.md) — the case for the API over the raw chain
* [Authentication](/mute.sh/api/getting-started/authentication.md) — the three ways to send a key
* [Pricing & tiers](/mute.sh/api/getting-started/pricing.md) — plans, quotas, what "1 token" means
* [Rate limits & quotas](/mute.sh/api/getting-started/rate-limits.md) — the headers on every response
* [Errors](/mute.sh/api/getting-started/errors.md) — error body shape and every status code
* [API reference: Markets](/mute.sh/api/api-reference/markets.md) — the core market endpoints, fully worked


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mute-sh.gitbook.io/mute.sh/api/getting-started/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.