---
title: "Live event stream (SSE)"
method: GET
path: "/api/v1/stream"
tags: ["Event Stream"]
---

# Live event stream (SSE)

`GET /api/v1/stream`

## Request

- Base URL: `https://cryptodataapi.com`
- URL: `https://cryptodataapi.com/api/v1/stream`
- Auth: API key in header `X-API-Key`

Real-time market events over Server-Sent Events: liquidations (OKX, Bybit,
Hyperliquid; $250+), $1M+ CEX whale transfers, Hyperliquid top-trader position
changes ($25K+), and funding moves, open-interest moves and 1-minute price
moves (0.10%+, perps trading $1M+/day) for every Hyperliquid perp.

Each message's `data` is one JSON event: `id`, `ts` (event time, ms),
`recv_ts` (when we saw it, ms), `type`, `venue`, `symbol`, plus type fields:
liquidation `side` (the LIQUIDATED position side) + `usd` (+ `px`, `sz` on
Hyperliquid); whale_transfer `exchange`, `chain`, `direction` (inflow/outflow),
`amount`, `usd`; whale_position `action` (entry/exit/increase/decrease), `side`,
`size`, `usd` (notional of the change at entry price), `address`, `change_pct`;
funding `rate_1h`, `prev_rate_1h`, `settle` (true = the hourly settlement
print); oi_delta `usd` (signed change), `pct`, `window_s` (~60 = minute move,
~300 = 5-minute jump), `oi_usd`; price_move `pct`, `price`, `prev_price`,
`window_s`.

Pro and Pro Plus. Free keys: `/stream/recent` (JSON, any key) or the keyless
`/stream/delayed` preview. Up to 3 concurrent streams per key.

## Query parameters

- `types` string, nullable: Comma-separated event types: liquidation, whale_transfer, whale_position, funding, oi_delta, price_move. Default: all.
- `symbols` string, nullable: Comma-separated base coins (BTC,ETH,SOL). Default: all.
- `min_usd` number: Drop events smaller than this USD size. Applies to events that carry `usd` (liquidation, whale_transfer, whale_position, oi_delta); funding and price_move always pass.
- `since_id` integer, nullable: Replay buffered events after this id before going live (~2h ring). The Last-Event-ID header does the same and wins when both are sent.

## Response `200`

Server-Sent Events. One JSON event per `data:` line, `id:` set for resume; `: ping` comments every 15s.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/cryptodataapi/apis/crypto-data-api.md) · [All operations](https://skmtc.dev/cryptodataapi/apis/crypto-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cryptodataapi/apis/crypto-data-api/revisions/8628b754ca81?raw)