websocket-client

1.9.0 · active · verified Sat Mar 28

A Python library for WebSocket communication, providing both high-level and low-level APIs. Current version: 1.9.0. Maintained with regular updates.

Warnings

breaking The 'run_forever' method requires a dispatcher for automatic reconnection. Without it, the method will not function as intended.
Fix: Install the 'rel' package and pass it as the dispatcher to 'run_forever'.
gotcha Some shells, such as zsh, require escaping of '[' and ']' characters in pip install commands.
Fix: Use 'pip install websocket-client\[optional\]' to install optional dependencies.

Install

pip install websocket-client Install websocket-client

Imports

WebSocketApp
```
from websocket import WebSocketApp
```
Ensure correct import path to avoid ImportError

Quickstart

A simple example demonstrating how to establish a WebSocket connection and handle messages.

import websocket

def on_message(ws, message):
    print(message)

def on_error(ws, error):
    print(error)

def on_close(ws, close_status_code, close_msg):
    print('### closed ###')

def on_open(ws):
    print('Opened connection')

if __name__ == '__main__':
    websocket.enableTrace(True)
    ws = websocket.WebSocketApp('wss://api.gemini.com/v1/marketdata/BTCUSD',
                              on_open=on_open,
                              on_message=on_message,
                              on_error=on_error,
                              on_close=on_close)
    ws.run_forever(dispatcher=rel, reconnect=5)
    rel.signal(2, rel.abort)
    rel.dispatch()

view raw JSON →