skip to navigation
skip to content

websocket-client 0.37.0

WebSocket client for python. hybi13 is supported.


websocket-client module is WebSocket client for python. This provide the low level APIs for WebSocket. All APIs are the synchronous functions.

websocket-client supports only hybi-13.




This module is tested on Python 2.7 and Python 3.x.

Type "python install" or "pip install websocket-client" to install.


from v0.16.0, we can install by "pip install websocket-client" for python 3.

This module depend on

- six
- backports.ssl_match_hostname for Python 2.x

How about Python 3

Now, we support python 3 on single source code from version 0.14.0. Thanks, @battlemidget and @ralphbean.

HTTP Proxy

Support websocket access via http proxy.
The proxy server must allow "CONNECT" method to websocket port.
Default squid setting is "ALLOWED TO CONNECT ONLY HTTPS PORT".

Current implementation of websocket-client is using "CONNECT" method via proxy.


.. code:: python

import websocket
ws = websocket.WebSocket()
ws.connect("ws://", http_proxy_host="proxy_host_name", http_proxy_port=3128)


Low Level API example

.. code:: python

from websocket import create_connection
ws = create_connection("ws://")
print "Sending 'Hello, World'..."
ws.send("Hello, World")
print "Sent"
print "Receiving..."
result = ws.recv()
print "Received '%s'" % result

If you want to customize socket options, set sockopt.

sockopt example

.. code:: python

from websocket import create_connection
ws = create_connection("ws://",
sockopt=((socket.IPPROTO_TCP, socket.TCP_NODELAY),))

You can also use your own class for the connection.

custom connection class example

..code:: python

from websocket import create_connection, WebSocket
class MyWebSocket(WebSocket):
def recv_frame(self):
frame = super().recv_frame()
print('yay! I got this frame: ', frame)
return frame

ws = create_connection("ws://",
sockopt=((socket.IPPROTO_TCP, socket.TCP_NODELAY),), class_=MyWebSocket)

JavaScript websocket-like API example

.. code:: python

import websocket
import thread
import time

def on_message(ws, message):
print message

def on_error(ws, error):
print error

def on_close(ws):
print "### closed ###"

def on_open(ws):
def run(*args):
for i in range(3):
ws.send("Hello %d" % i)
print "thread terminating..."
thread.start_new_thread(run, ())

if __name__ == "__main__":
ws = websocket.WebSocketApp("ws://",
on_message = on_message,
on_error = on_error,
on_close = on_close)
ws.on_open = on_open


How to disable ssl cert verification?

Please set sslopt to {"cert_reqs": ssl.CERT_NONE}.

WebSocketApp sample

.. code:: python

ws = websocket.WebSocketApp("wss://")
ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE})

create_connection sample

.. code:: python

ws = websocket.create_connection("wss://",
sslopt={"cert_reqs": ssl.CERT_NONE})

WebSocket sample

.. code:: python

ws = websocket.WebSocket(sslopt={"cert_reqs": ssl.CERT_NONE})

How to disable hostname verification.

Please set sslopt to {"check_hostname": False}.
(since v0.18.0)

WebSocketApp sample

.. code:: python

ws = websocket.WebSocketApp("wss://")
ws.run_forever(sslopt={"check_hostname": False})

create_connection sample

.. code:: python

ws = websocket.create_connection("wss://",
sslopt={"check_hostname": False})

WebSocket sample

.. code:: python

ws = websocket.WebSocket(sslopt={"check_hostname": False})

How to enable `SNI <http:"" wiki="" server_name_indication="">`_?

SNI support is available for Python 2.7.9+ and 3.2+. It will be enabled automatically whenever possible.

Sub Protocols.

The server needs to support sub protocols, please set the subprotocol like this.

Subprotocol sample

.. code:: python

ws = websocket.create_connection("ws://", subprotocols=["binary", "base64"])
============ is simple WebSocket test(debug) tool.

sample for

$ ws://
Press Ctrl+C to quit
> Hello, WebSocket
< Hello, WebSocket
> How are you?
< How are you?


usage:: [-h] [-v [VERBOSE]] ws_url

WebSocket Simple Dump Tool

positional arguments:
ws_url websocket url. ex. ws://

optional arguments:
-h, --help show this help message and exit
-v VERBOSE, --verbose VERBOSE set verbose mode. If set to 1, show opcode. If set to 2, enable to trace websocket module


$ ws://
$ ws:// -v
$ ws:// -vv  
File Type Py Version Uploaded on Size
websocket_client-0.37.0.tar.gz (md5) Source 2016-04-14 189KB