* Round fill price and qty to 7 digits in bybit gw plugin * Remove erroneous line of code that reset filled_quantity to 0 on each update (it was causing partial fills to be overcounted)
lib_python_interop
This library binds c++ types to python market data and execution plugins which can be loaded at runtime.
Dependencies
Notes
-
Because this is python, market data enums (SecurityType, Venue, Side, etc.) are represented as strings
- Parsing is NOT case sensitive (though it is conventional to use
UPPER_CASEstrings) - Type name prefixes (SECURITY_TYPE_, VENUE_, SIDE_ etc.) are NOT required
- Having said that, we recommend UPPER_CASE strings without the type prefix. Here are a few examples:
Enum Examples SecurityType "SPOT", "FUTURE", "OPTION" Venue "BYBIT", "GATEIO", "DERIBIT", "COINBASE" Side "BUY", "SELL" OrderType "LIMIT", "MARKET" OrderStatus "NEW", "PARTIALLY_FILLED", "FILLED", "CANCELED" SecurityType "SPOT", "FUTURE", "OPTION" - Parsing is NOT case sensitive (though it is conventional to use
-
All .py files in the
python_interop_pluginsdir are copied to a special plugins directory at build time, so they may be loaded at runtime. -
Type hints for the c++ defined module,
python_interop_module, should work as long sparkd-debug-clang is built.We use pybind11-stubgen to generate stubs as part of the build
Examples
Md Provider Plugin
import time
import python_md_module as pymd
class MdProviderExample(pymd.MdProvider):
def __init__(self):
super(MdProviderExample, self).__init__()
pass
def start(self, sink: pymd.MdSink):
print("Starting MdProviderExample")
# An actual implementation would subscribe to market data here.
# This is just an example to show you how to pass market data
# back to the c++ Spark api.
def add_dummy_security():
# This example populates a dummy security for demonstrative purposes.
# Of course, an actual implementation would populate the security list
# with data received from the exchange (or some other provider).
sec = pymd.PySecurity()
sec.set_venue("GLBX")
sec.set_name("ESH8")
sec.set_asset("ES")
fut = pymd.PyFuture()
fut.set_expiration("2025-03-28")
sec.set_future(fut)
# Note: the example only adds 1 sec, but batch adds are supported.
sec_list = pymd.PySecurityList()
sec_list.append(sec)
sink.on_securities(sec_list)
def add_dummy_trade():
trade = pymd.PyTrade()
trade.set_venue("GLBX")
trade.set_security_type("FUTURE")
trade.set_exchange_security_id("ESH8")
trade.set_price(5684.25)
trade.set_quantity(1)
trade.set_aggressor_side("BUY")
trade.set_timestamp(time.time_ns())
add_dummy_security()
add_dummy_trade()
def stop(self):
print("Stopping MdProviderExample")
Execution Gateway Plugin
import json
import logging
import threading
from typing import Optional
import python_execution_module as pyexe
from py_execution_utils import configure_logger, run_websocket
class ExecutionGatewayExample(pyexe.ExecutionGateway):
def __init__(self):
super(ExecutionGatewayExample, self).__init__()
self.bridge: Optional[pyexe.ExecutionGatewayBridge] = None
self.stop_event = threading.Event()
# Logs to file /home/bts/sparkdata/data/logging.sparkd/<name>_log
# (name is 'py_execution_example' in this case).
self.logger = configure_logger(logging.getLogger("py_execution_example"))
def start_impl(self, bridge: pyexe.ExecutionGatewayBridge):
def on_message(msg: str):
# This example assumes msg has a particular structure. Obviously, each exchange is
# different, so this isn't a one-size-fits-all solution.
data = json.loads(msg)
event = data.get("e")
if event == "executionReport":
upd = json.loads(str(msg))
er = pyexe.PyExecutionReport()
# TODO: Resolve exch key to bts key
# er.set_key(bts_key)
er.set_exchange_security_id(upd["s"])
er.set_security_type("SPOT")
er.set_is_buy(upd["S"] == "BUY")
er.set_price(float(upd["p"]))
er.set_quantity(float(upd["q"]))
er.set_last_filled_price(upd["L"])
er.set_last_filled_quantity(upd["l"])
# ...
# TODO: Fill in remaining fields
bridge.on_execution_report(er)
else:
self.logger.error("Unknown event %s. Full msg %s" % (event, msg))
run_websocket(
"wss://some_exch.com/ws", self.stop_event, self.logger, on_message
)
def start(self, bridge: pyexe.ExecutionGatewayBridge):
# Connect to the exchange, subscribe to order updates, etc. Don't block this thread.
# Spawn new thread(s) for long running operations websocket msg loops, ping loops, etc.
self.logger.info("Starting ExecutionGatewayExample")
self.bridge = bridge
self.ws_thread = threading.Thread(target=lambda: self.start_impl(bridge))
self.ws_thread.start()
def stop(self):
self.logger.info("Stopping ExecutionGatewayExample")
self.stop_event.set()
def create_order(self, req: pyexe.PyCreateOrderRequest):
self.logger.info("create_order. %s" % str(req))
# TODO: Send REST or ws request
def cancel_replace_order(self, req: pyexe.PyCancelReplaceOrderRequest):
self.logger.info("cancel_replace_order. %s" % str(req))
# TODO: Send REST or ws request
def cancel_order(self, req: pyexe.PyCancelOrderRequest):
self.logger.info("cancel_order. %s" % str(req))
# TODO: Send REST or ws request