UmbraUmbrafeed
Open Dashboard

Getting started

Quickstart

Make your first request in under a minute. All you need is an API key and curl.

1. Get a key

Sign in to the dashboard, open Profile → Developer, select a Free, Builder or Pro API plan, and create a key. The secret is shown once — store it safely.

2. Call an endpoint

Search the production symbol catalog:

bash
curl -H "apikey: $UMBRA_API_KEY" \
  "https://api.umbrafeed.com/api/v1/data/symbols/search?q=BTC&limit=5"

3. Stream live

Open the canonical funding stream from a server-side Node client (Builder tier and up):

javascript
import WebSocket from "ws";

const ws = new WebSocket(
  "wss://api.umbrafeed.com/api/v1/fundingbot/ws",
  { headers: { apikey: process.env.UMBRA_API_KEY } },
);
ws.onmessage = (e) => {
  const event = JSON.parse(e.data);
  console.log(event);
};

WebSocket edge access is live

Cloudflare permits authenticated GET upgrades on the four machine WebSocket paths. Standard server-side Python and Node clients reach Kong; an invalid key is rejected with 401.

Tip

Use REST for bounded history and snapshots, MCP for agent tool calls, and WebSockets for continuous delivery. All three transports derive freshness, history and usage limits from the same API key.

Next steps