vnpy_okx 2026.3.28

OKX trading gateway for VeighNa.

OKX trading gateway for VeighNa Evo

Introduction

This gateway is developed based on OKX's V5 REST and Websocket API, and supports spot, linear contract and inverse contract trading.

For derivatives contract trading, please notice:

1. Only supports one-way position mode.

Install

Users can easily install vnpy_okx by pip according to the following command.

pip install vnpy_okx

Also, users can install vnpy_okx using the source code. Clone the repository and install as follows:

git clone https://github.com/veighna-global/vnpy_okx.git && cd vnpy_okx

python setup.py install

A Simple Example

Save this as run.py.

from vnpy.event import EventEngine
from vnpy.trader.engine import MainEngine
from vnpy.trader.ui import MainWindow, create_qapp

from vnpy_okx import OkxGateway


def main() -> None:
    """main entry"""
    qapp = create_qapp()

    event_engine = EventEngine()
    main_engine = MainEngine(event_engine)
    main_engine.add_gateway(OkxGateway)

    main_window = MainWindow(main_engine, event_engine)
    main_window.showMaximized()

    qapp.exec()


if __name__ == "__main__":
    main()