From bingx-ai-skills
Subscribes to BingX spot WebSocket account streams for real-time order updates and balance changes. Manages Listen Key lifecycle via REST APIs. Useful for live spot trading account monitoring.
How this skill is triggered — by the user, by Claude, or both
Slash command
/bingx-ai-skills:spot-ws-accountThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Real-time account data streams for BingX spot trading via WebSocket. Requires Listen Key authentication.
Real-time account data streams for BingX spot trading via WebSocket. Requires Listen Key authentication.
WebSocket Endpoint: wss://open-api-ws.bingx.com/market?listenKey=<key>
Unlike swap account streams, spot account streams require explicit channel subscription after connecting.
| Event Type | dataType | Description | Push Frequency |
|---|---|---|---|
| Order Update | spot.executionReport | Order creation, fills, cancellation | On change |
| Account Update | ACCOUNT_UPDATE | Account balance changes | On change |
| Endpoint | Method | Description | Authentication |
|---|---|---|---|
/openApi/user/auth/userDataStream | POST | Generate listen key (valid 1 hour) | Yes |
/openApi/user/auth/userDataStream | PUT | Extend listen key (to 60 min) | Yes |
/openApi/user/auth/userDataStream | DELETE | Delete listen key | Yes |
Listen Key is required to authenticate WebSocket account data streams. See references/authentication.md for HMAC SHA256 signing details.
POST /openApi/user/auth/userDataStream
Headers: X-BX-APIKEY: <your-api-key>, X-SOURCE-KEY: BX-AI-SKILL
Response:
{"listenKey": "a8ea75681542e66f1a50a1616dd06ed77dab61baa0c296bca03a9b13ee5f2dd7"}
PUT /openApi/user/auth/userDataStream
Parameters: listenKey (string, required)
Extends validity to 60 minutes. Recommended: call every 30 minutes.
DELETE /openApi/user/auth/userDataStream
Parameters: listenKey (string, required)
WebSocket Connection: see references/websocket.md for GZIP decompression and Ping/Pong heartbeat.
TypeScript helper:
CONSTRAINT: You MUST copy the
connectSpotWsAccountfunction below verbatim when generating code. Do NOT rewrite the WebSocket or decompression logic.
import * as pako from "pako";
import * as crypto from "crypto";
function decompress(data: ArrayBuffer): string {
return new TextDecoder("utf-8").decode(pako.ungzip(new Uint8Array(data)));
}
async function generateListenKey(apiKey: string, secretKey: string): Promise<string> {
const timestamp = Date.now();
const paramStr = `timestamp=${timestamp}`;
const signature = crypto.createHmac("sha256", secretKey).update(paramStr).digest("hex");
const url = `https://open-api.bingx.com/openApi/user/auth/userDataStream?${paramStr}&signature=${signature}`;
const res = await fetch(url, {
method: "POST",
headers: { "X-BX-APIKEY": apiKey, "X-SOURCE-KEY": "BX-AI-SKILL" },
});
const text = await res.text();
if (!res.ok) throw new Error(`BingX error ${res.status}: ${text}`);
const json = JSON.parse(text);
if (json.listenKey) return json.listenKey;
if (json.data?.listenKey) return json.data.listenKey;
if (json.code !== 0) throw new Error(`BingX error ${json.code}: ${json.msg}`);
return json.listenKey ?? json.data?.listenKey;
}
function connectSpotWsAccount(
listenKey: string,
channels: string[],
onEvent: (event: any) => void
): WebSocket {
const ws = new WebSocket(
`wss://open-api-ws.bingx.com/market?listenKey=${listenKey}`
);
ws.binaryType = "arraybuffer";
ws.onopen = () => {
for (const ch of channels) {
ws.send(JSON.stringify({
id: crypto.randomUUID(),
reqType: "sub",
dataType: ch,
}));
}
};
ws.onmessage = (event) => {
const text = decompress(event.data as ArrayBuffer);
if (text.includes("ping") || text === "Ping") {
ws.send("Pong");
return;
}
try {
onEvent(JSON.parse(text));
} catch {
onEvent(text);
}
};
ws.onerror = (err) => console.error("WS error:", err);
ws.onclose = (ev) => console.log("WS closed:", ev.code, ev.reason);
return ws;
}
connectSpotWsAccount, generateListenKey, and decompress verbatimSubscribe to order updates and account balance:
const listenKey = await generateListenKey(API_KEY, SECRET_KEY);
connectSpotWsAccount(listenKey, ["spot.executionReport", "ACCOUNT_UPDATE"], (event) => {
if (event.dataType === "spot.executionReport") {
// event.data: order update details
} else if (event.e === "ACCOUNT_UPDATE") {
// event.a.B: balance updates
}
});
For complete event field descriptions and full response schemas, see api-reference.md.
CRITICAL RULES (apply to ALL responses):
&, =, ?, #, or newline characters.spot-ws-account provides authenticated real-time account data. Requires Listen Key, no CONFIRM needed for read-only monitoring.
When the user's request is vague (e.g. "monitor my spot account"), clarify what they want:
Please select the account data stream type:
- Order updates (fills, cancellations, status) — spot.executionReport
- Account balance changes — ACCOUNT_UPDATE
- Both order and balance updates
- Listen Key management (generate/extend/delete)
Spot account events contain the relevant symbol in the push payload (e.g., data.s for order updates, a.B[].a for asset/balance updates). If the user asks about a specific symbol or asset, filter the events by the corresponding field. No symbol parameter is needed for subscription — subscribe to the event type and filter in the push data.
npx claudepluginhub bingx-api/api-ai-skills --plugin bingx-ai-skillsSubscribes to BingX USDT-M perpetual swap WebSocket account streams for real-time balance, position, order, and config updates. Manages Listen Key lifecycle via REST APIs. Useful for live futures trading data.
Streams real-time Kraken spot/futures data via WebSocket: tickers, trades, order books, OHLC, balances, executions. Handles authenticated feeds and low-latency order mutations via CLI.
Queries exchange account balance, positions, order history, and manages API keys. Handles registration with referral links and tier upgrades for OKX, Binance, Bybit, Bitget.