Skip to main content

Bitmex websocket API

Project description


$ pip install bitmex-websocket


  1. First you should set your BITMEX_API_KEY and BITMEX_API_SECRET. It can be done as follows:
$ cp .env.example .env
#  edit .env to reflect your API key and secret
$ source .env
  1. Then in your project you can consume Instrument as follows:
import websocket

from bitmex_websocket import Instrument
from bitmex_websocket.constants import InstrumentChannels


channels = [

XBTUSD = Instrument(symbol='XBTUSD',
XBTUSD.on('action', lambda msg: print(message))



Run example scripts:

$ RUN_ENV=development python -m ./examples/


Testing is set up using pytest <> and coverage is handled with the pytest-cov plugin.

Run your tests with pytest in the root directory.

Coverage is ran by default and is set in the pytest.ini file. To see an html output of coverage open htmlcov/index.html after running the tests.

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
bitmex_websocket-0.2.55-py2.py3-none-any.whl (8.6 kB) Copy SHA256 hash SHA256 Wheel 3.6
bitmex_websocket-0.2.55-py3.6.egg (14.6 kB) Copy SHA256 hash SHA256 Egg 3.6

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page