Skip to main content

Documentation

API reference, methodology, and data handling. Full docs are in the repository docs/ folder.

API reference

All endpoints return JSON unless noted (CSV for export). Base URL is the same origin as this dashboard.

  • GET /api/status — Data freshness & health
  • GET /api/markets — List markets (platform, category, limit, offset)
  • GET /api/markets/[id] — Market metadata
  • GET /api/markets/[id]/liquidity — Liquidity time-series (from, to, limit)
  • GET /api/markets/[id]/participants — Top wallets by volume (limit)
  • GET /api/social/[marketId] — Social posts & metrics (Kash)
  • GET /api/benchmarks — Platform metrics (from, to)
  • GET /api/export/market/[id]/daily — CSV download (from, to)

Full reference with query params and response shapes: see docs/API.md in the repo. Machine-readable: docs/openapi.yaml (OpenAPI 3.x).

Methodology

  • Spreads — Top-of-book (best ask − best bid) in bps. Pred from order book; Kash implied from bonding curve.
  • Depth — Top 1 and top 5 levels (bid/ask). Kash approximated from curve.
  • Volume & participation — Notional, trade count, unique traders from market_daily_aggregates and snapshots.
  • Gini participation — 0 = even; 1 = one wallet dominates. market_daily_aggregates.gini_participation.
  • Data freshness — Snapshots typically every 15m; daily aggregates run once per day (e.g. 00:00 UTC).

Full definitions: docs/METHODOLOGY.md.

Data & privacy

Data is stored in Postgres (Supabase). We use on-chain data (addresses, transactions) and API-sourced data (Kalshi, Polymarket, public social metrics). No PII beyond what is already public. Secrets are in environment variables; we do not share data with third parties.

Full note: docs/DATA_AND_PRIVACY.md.