# OKX trading gateway for VeighNa Evo
<p align="center">
<img src ="https://github.com/veighna-global/vnpy_evo/blob/dev/logo.png" width="300" height="300"/>
</p>
<p align="center">
<img src ="https://img.shields.io/badge/version-2025.10.08-blueviolet.svg"/>
<img src ="https://img.shields.io/badge/platform-windows|linux|macos-yellow.svg"/>
<img src ="https://img.shields.io/badge/python-3.10|3.11|3.12|3.13-blue.svg" />
<img src ="https://img.shields.io/github/license/veighna-global/vnpy_okx.svg?color=orange"/>
</p>
## 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()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "vnpy_okx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "algotrading, btc, crypto, investment, okx, quant, quantitative, trading",
"author": null,
"author_email": "VeighNa Global <veighna@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/56/50309eaa3c7d264014ba859f3480a61e0d499e8c54e5e638a20560caac63/vnpy_okx-2025.10.8.tar.gz",
"platform": null,
"description": "# OKX trading gateway for VeighNa Evo\n\n<p align=\"center\">\n <img src =\"https://github.com/veighna-global/vnpy_evo/blob/dev/logo.png\" width=\"300\" height=\"300\"/>\n</p>\n\n<p align=\"center\">\n <img src =\"https://img.shields.io/badge/version-2025.10.08-blueviolet.svg\"/>\n <img src =\"https://img.shields.io/badge/platform-windows|linux|macos-yellow.svg\"/>\n <img src =\"https://img.shields.io/badge/python-3.10|3.11|3.12|3.13-blue.svg\" />\n <img src =\"https://img.shields.io/github/license/veighna-global/vnpy_okx.svg?color=orange\"/>\n</p>\n\n## Introduction\n\nThis gateway is developed based on OKX's V5 REST and Websocket API, and supports spot, linear contract and inverse contract trading.\n\n**For derivatives contract trading, please notice:**\n\n1. Only supports one-way position mode.\n\n## Install\n\nUsers can easily install ``vnpy_okx`` by pip according to the following command.\n\n```\npip install vnpy_okx\n```\n\nAlso, users can install ``vnpy_okx`` using the source code. Clone the repository and install as follows:\n\n```\ngit clone https://github.com/veighna-global/vnpy_okx.git && cd vnpy_okx\n\npython setup.py install\n```\n\n## A Simple Example\n\nSave this as run.py.\n\n```\nfrom vnpy.event import EventEngine\nfrom vnpy.trader.engine import MainEngine\nfrom vnpy.trader.ui import MainWindow, create_qapp\n\nfrom vnpy_okx import OkxGateway\n\n\ndef main() -> None:\n \"\"\"main entry\"\"\"\n qapp = create_qapp()\n\n event_engine = EventEngine()\n main_engine = MainEngine(event_engine)\n main_engine.add_gateway(OkxGateway)\n\n main_window = MainWindow(main_engine, event_engine)\n main_window.showMaximized()\n\n qapp.exec()\n\n\nif __name__ == \"__main__\":\n main()\n\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "OKX trading gateway for VeighNa.",
"version": "2025.10.8",
"project_urls": {
"Homepage": "https://www.github.com/veighna-global",
"Source": "https://www.github.com/veighna-global"
},
"split_keywords": [
"algotrading",
" btc",
" crypto",
" investment",
" okx",
" quant",
" quantitative",
" trading"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c5cb8dc7c1c623ec83a6057b58c4dc02dc56ce932c3d1192ecb23af85b64602e",
"md5": "f8410832767cd3cd56e3ea82d7a15b3d",
"sha256": "9359d6c73fe514852ec678015f86493dd8c155c2f2cbfa27eebb2eabe778bedb"
},
"downloads": -1,
"filename": "vnpy_okx-2025.10.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8410832767cd3cd56e3ea82d7a15b3d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15302,
"upload_time": "2025-10-08T01:57:35",
"upload_time_iso_8601": "2025-10-08T01:57:35.166785Z",
"url": "https://files.pythonhosted.org/packages/c5/cb/8dc7c1c623ec83a6057b58c4dc02dc56ce932c3d1192ecb23af85b64602e/vnpy_okx-2025.10.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fa5650309eaa3c7d264014ba859f3480a61e0d499e8c54e5e638a20560caac63",
"md5": "b17f2c579d1d2f242569674529959c68",
"sha256": "d396a0522e0d82729394294e77c350468cd7e674a2700ff2a8e72090995b5c62"
},
"downloads": -1,
"filename": "vnpy_okx-2025.10.8.tar.gz",
"has_sig": false,
"md5_digest": "b17f2c579d1d2f242569674529959c68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15891,
"upload_time": "2025-10-08T01:57:36",
"upload_time_iso_8601": "2025-10-08T01:57:36.657373Z",
"url": "https://files.pythonhosted.org/packages/fa/56/50309eaa3c7d264014ba859f3480a61e0d499e8c54e5e638a20560caac63/vnpy_okx-2025.10.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 01:57:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vnpy_okx"
}
JSON