Disconnects from the WebSocket server. If there is no active connection, a warning is logged. Otherwise, all connections in the connection pool are closed gracefully, and a message is logged indicating that the connection has been disconnected.
A Promise that resolves when all connections have been closed.
Pushed when a fund transfer fails.
Update Speed: Real-time
Pushed when a fund transfer into or out of the prediction wallet succeeds. The direction and the token are not included (currently USDT only).
Update Speed: Real-time
Checks if the WebSocket connection is currently open.
true if the connection is open, false otherwise.
Checks if the WebSocket connection is subscribed to the specified stream.
The name of the WebSocket stream to check.
true if the connection is subscribed to the stream, false otherwise.
Pushed when a limit order is fully filled.
Update Speed: Real-time
Pushed on each new partial fill of a limit order. One order can be pushed several times,
so always remove duplicates by pushId.
Update Speed: Real-time
Pushed when a limit order is rejected when placed. No amount is included.
Update Speed: Real-time
Pushed when the user's limit order is successfully placed on the order book.
Update Speed: Real-time
Pushed when the user's market buy order fails or expires.
Update Speed: Real-time
Pushed when the user's market buy order is fully filled.
Update Speed: Real-time
Pushed when a market is resolved, to every user holding a position in it, win or lose. No amount or outcome is included — call the REST API for the user's profit and loss.
Update Speed: Real-time
Pushed when the user's market sell order fails or expires.
Update Speed: Real-time
Pushed when the user's market sell order is fully filled.
Update Speed: Real-time
Removes an event listener for the specified WebSocket event.
The WebSocket event to stop listening for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
The callback function that was previously added as the event listener.
Adds an event listener for the specified WebSocket event.
The WebSocket event to listen for, such as 'open', 'message', 'error', 'close', 'ping', or 'pong'.
The callback function to be executed when the event is triggered. The function can accept any number of arguments.
Order book (bid/ask) updates for one market. Only active markets are pushed.
Update Speed: Real-time
Request parameters.
Pushed when a claim fails completely — a single claim, or every item of a batch. For a batch, only the first failed item's amount and outcome are included.
Update Speed: Real-time
Pushed when a claim fully succeeds — a single claim, or every item of a batch. Only the total is reported; no market title or outcome is included.
Update Speed: Real-time
Subscribes to one or multiple WebSocket streams Handles both single and pool modes
Single stream name or array of stream names to subscribe to
Optionalid: stringOptional subscription ID
void
Unsubscribes from one or multiple WebSocket streams Handles both single and pool modes
Single stream name or array of stream names to unsubscribe from
Optionalid: stringOptional unsubscription ID
void
Pushed when only part of a batch claim succeeds. Only
pushIdis included — call the REST API for details.Update Speed: Real-time