https://api.coinversa.ai/api/public/v1
Auth: X-API-Key header on every request — see authentication
Spec: https://api.coinversa.ai/openapi.json (OpenAPI 3.1)
The WebSocket fill stream is not part of this spec or this reference — it is a separate protocol on wss://ws.coinversa.ai, documented in the WebSocket section.
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.
Endpoint families
Only some endpoints carry tags so far, so the generated reference mixes a few tagged groups with a long untagged list. These are the endpoint families you’ll find in it:- Pulse — historical trader and cohort analytics; the rich endpoints (
/pulse/*), including the Daily Pulse editions (/pulse/daily/*). - Builders — the builder-code economy: ledger-exact revenue, attributed flow, retention, overlap (
/builders/*,/trader/{address}/builders). Start from the endpoint guide. - Live — near-real-time market and risk (
/live/*), including the Pro chart-layer endpoints: cohort positioning by entry price (/live/positioning-by-entry/{coin}), large fills (/live/whale-trades/{coin}) and cohort bias history in layer format (/live/cohort-bias-history/{coin}?format=layer). See Chart layers. For fills pushed as they land rather than polled, use the WebSocket. - Market — mark price, L2 orderbook and positions (
/market/price/{symbol},/market/orderbook/{symbol},/market/positions/{address}), L4 order-book rollups from Coinversa snapshots (/market/book/*), historical open interest (/market/historical-oi), and OHLCV candles at/pulse/market/candles/recent/{symbol}(intervals 1m, 5m, 15m, 1h, 4h, 1d; up to 500 per call). - Assets — canonical cross-market taxonomy (
/assets/*). - HIP-4 — outcome contract discovery, settlements, perp-position context (
/hip4/*). - Entities & exchange — owner-level resolution (
/entity/*,/entities/*) and exchange-wide aggregates (/exchange/*). - Utility — plan introspection (
/plan) and the chain-verification stamp (/census/stamp).
Conventions
- Success responses return the resource body directly. Errors are JSON problem details —
title,status,detail, a machine-matchablecode(pluscurrent_tier/required_tier/upgrade_urlon tier gates), and, when available, areason(missing_api_key,invalid_api_key,insufficient_tier,invalid_parameters,account_suspended). A suspended account gets 403 withcode: "ACCOUNT_SUSPENDED"and no tier fields: contact support rather than retrying or upgrading. See error responses. - 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+offsetor cursor-stylesince/untildepending on the endpoint.
Tier requirements
Every endpoint requires an API key; each is gated at Free, Starter, or Pro — the full matrix is in Tiers. A 403 carriescode: "TIER_GATE" with required_tier and an upgrade_url, so agents can explain exactly what a request needs.
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.
