krakenfx/kraken-cli/kraken-ws-streaming

kraken-ws-streaming

Use this skill for:

• streaming live price, trade, and order book data
• monitoring authenticated feeds (executions, balances)
• futures-specific streaming (fills, positions, balances)
• building event-driven agent loops

Output Format

All WebSocket commands emit NDJSON (one JSON object per line) to stdout. Parse line by line:

kraken ws ticker BTC/USD -o json 2>/dev/null | while read -r line; do
  echo "$line" | jq -r '.data[0].last // empty'
done

Do not attempt to parse the full stream as a single JSON object.

Spot Public Streams

Ticker (best bid/ask, last price, volume):

kraken ws ticker BTC/USD -o json 2>/dev/null

Ticker with BBO trigger (fires only on best-bid/offer changes):

kraken ws ticker BTC/USD --event-trigger bbo -o json 2>/dev/null

Trades:

kraken ws trades BTC/USD -o json 2>/dev/null

Order book (L2, configurable depth):

kraken ws book BTC/USD --depth 10 -o json 2>/dev/null

OHLC candles:

kraken ws ohlc BTC/USD --interval 1 -o json 2>/dev/null

Instrument metadata:

kraken ws instrument BTC/USD -o json 2>/dev/null

Spot Private Streams (Authenticated)

Execution updates (fills, order state changes):

kraken ws executions -o json 2>/dev/null

Balance updates:

kraken ws balances -o json 2>/dev/null

L3 order book:

kraken ws level3 BTC/USD -o json 2>/dev/null

Futures Streams

Futures ticker:

kraken futures ws ticker PF_XBTUSD -o json 2>/dev/null

Futures trades:

kraken futures ws trades PF_XBTUSD -o json 2>/dev/null

Futures order book:

kraken futures ws book PF_XBTUSD -o json 2>/dev/null

Futures Private Streams (Authenticated)

Fills:

kraken futures ws fills -o json 2>/dev/null

Open orders:

kraken futures ws open-orders -o json 2>/dev/null

Open positions:

kraken futures ws open-positions -o json 2>/dev/null

Balances and margins:

kraken futures ws balances -o json 2>/dev/null

Notifications:

kraken futures ws notifications -o json 2>/dev/null

Account log:

kraken futures ws account-log -o json 2>/dev/null

WebSocket Order Mutations (Spot)

Place, amend, and cancel orders over WebSocket for lower latency. Each one needs explicit human approval; add-order and batch-add take --validate for a dry run, the others have none:

kraken ws add-order --order-type limit --side buy --symbol BTC/USD --order-qty 0.001 --limit-price 50000 --validate -o json 2>/dev/null
kraken ws amend-order --order-id OABC12 --limit-price 51000 -o json 2>/dev/null
kraken ws cancel-order --order-id OABC12 -o json 2>/dev/null
kraken ws cancel-all -o json 2>/dev/null
kraken ws batch-add --symbol BTC/USD --orders '[{"order_type":"limit","side":"buy","order_qty":0.001,"limit_price":50000},{"order_type":"limit","side":"sell","order_qty":0.001,"limit_price":70000}]' --validate -o json 2>/dev/null
kraken ws batch-cancel --orders OABC12 ODEF34 -o json 2>/dev/null

batch-add takes 2 to 15 orders and batch-cancel 2 to 50 IDs.

Dead man's switch over WebSocket:

kraken ws cancel-after 60 -o json 2>/dev/null

Agent Loop Pattern

A typical event-driven agent reads from a stream and acts on each event:

kraken ws ticker BTC/USD -o json 2>/dev/null | while read -r line; do
  LAST=$(echo "$line" | jq -r '.data[0].last // empty')
  [ -z "$LAST" ] && continue
  # Agent logic: compare price to thresholds, trigger actions
done

For multi-feed agents, run each stream in a background process and merge events.

Context Efficiency

• Use --depth to limit order book snapshot size.
• Use --event-trigger bbo on tickers to reduce noise.
• Prefer streaming over high-frequency REST polling.
• Close streams when no longer needed; each holds a connection.

Hard Rules

• WebSocket order mutations are flagged as dangerous. Require human approval.
• Never treat NDJSON stream output as a single JSON document.
• Handle stream disconnects gracefully. Spot kraken ws streams reconnect with paced exponential backoff until interrupted, and print a "type":"reconnected" line before the fresh snapshot. kraken futures ws streams print no such line and exit with a websocket error after 12 reconnects in a row that never stay up for 30 seconds.
• If you hit a mismatch between what you are trying to do and the CLI's interface or responses — including a mismatch between this skill and the installed CLI version's contract — feel free to submit feedback with kraken feedback.