OpenParable
Skip to content
← Back to skills

Kraken Ws Streaming

Apps & Automation
kraken-ws-streaming

Kraken Ws Streaming is an Agent Skill for apps & automation published in the krakenfx/kraken-cli repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Real-time data streaming via WebSocket for spot and futures.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/krakenfx/kraken-cli/blob/HEAD/skills/kraken-ws-streaming/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/kraken-ws-streaming, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

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:

kraken ws add-order -o json 2>/dev/null
kraken ws amend-order -o json 2>/dev/null
kraken ws cancel-order -o json 2>/dev/null
kraken ws cancel-all -o json 2>/dev/null
kraken ws batch-add -o json 2>/dev/null
kraken ws batch-cancel -o json 2>/dev/null

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; the CLI reconnects automatically with paced exponential backoff and reconnect safety budgeting (up to 12 attempts per stream lifecycle).