UmbraUmbrafeed
Open Dashboard

Getting started

Umbrafeed API

The market-event layer for crypto and tokenized finance, as a machine-readable feed. Spread, splash, funding, price and metadata endpoints over REST + WebSocket — for bots, quant research and AI agents.

Machine access is live

Free, Builder and Pro plans, API keys, REST data routes, eleven MCP data tools, machine WebSockets and customer webhooks are enabled in production. The separately documented /v1 event API is a planned contract and still returns 404. Start with the live endpoint list.

Overview

The live rail exposes market-history and dashboard snapshots over REST, eleven read-only data tools over MCP, and market/event streams over authenticated WebSockets. A future uniform event API will add the five /v1 families shown in the planned reference.

Live REST responses use the current typed SDP wire messages, while the family WebSocket routes deliver canonical derived events. The future uniform /v1 contract adds allowlisted envelopes and a per-consumer trace watermark; those fields are not claimed for the live rail.

Endpoint families

Spreads

Cross-venue price dislocations (open / close events).

Splash

Price spikes & dumps on 1s candles.

Funding

Cross-exchange funding ΔF and perp↔spot hedges.

Prices

1 Hz last/mark snapshot across CEX + DEX.

Metadata

Leverage caps, limits, funding, volume per venue.

Base URL

All live requests go through the Umbra gateway:

text
REST: https://api.umbrafeed.com/api/v1/data
MCP:  https://api.umbrafeed.com/mcp
WS:   wss://api.umbrafeed.com/api/v1/{data|spreadbot|xbot|fundingbot}/ws

WebSocket endpoints use the same host with the wss:// scheme. Continue to Quickstart to make your first call, or Authentication for key setup.