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

# Introduction

> 96 endpoints under /api/public/v1, auto-generated from the live Coinversa OpenAPI spec.

The Coinversa Pulse REST API exposes everything the MCP server uses — 96 endpoints covering trader analytics, market data, live risk, HIP-4 outcomes, and the cross-market asset registry.

**Base URL:** `https://api.coinversa.ai/api/public/v1`
**Auth:** `X-API-Key` header on every request — see [authentication](/authentication)
**Spec:** [`https://api.coinversa.ai/openapi.json`](https://api.coinversa.ai/openapi.json) (OpenAPI 3.1)

The reference pages in the sidebar are auto-generated from the spec. Every endpoint has parameter docs, response schemas, and a "Try it" panel that issues live requests against production using your key.

## Sections

* **Pulse** — historical trader and cohort analytics; the rich endpoints (`/pulse/*`).
* **Live** — near-real-time market and risk (`/live/*`).
* **Market** — direct Hyperliquid passthroughs for mark price, OI, orderbook, candles (`/market/*`).
* **Assets** — canonical cross-market taxonomy (`/assets/*`).
* **HIP-4** — outcome contract discovery, settlements, perp-position context (`/hip4/*`).
* **Wallet** — per-wallet risk and history (`/wallet/:address/*`).

## Conventions

* All responses use `success: true | false`. Errors include a human-readable `error` field.
* Timestamps are unix milliseconds unless explicitly noted as ISO strings.
* Numeric fields are JSON numbers (be aware of float precision on large notionals — most are within JS-safe-integer range).
* Pagination uses `limit` + `offset` or cursor-style `since` / `until` depending on the endpoint.

## Tier requirements

Most endpoints are accessible to **all** tiers (Free included). A handful of deep-analytics endpoints require **Pro** (e.g. `/hip4/outcomes/{id}/perp-position-context`). Tier requirements are noted on each endpoint's reference page and enforced by the API — a 403 response includes a Stripe upgrade URL.

## Stability

The public API surface is considered stable. Breaking changes are versioned (`v1` → `v2`); additive changes (new endpoints, new fields) ship without version bumps. The MCP server, by contrast, evolves its tool catalog more aggressively — see [github.com/Coinversaa/mcp-server/releases](https://github.com/Coinversaa/mcp-server/releases).
