# OKX trading gateway for VeighNa Evo
<p align="center">
<img src ="https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy-logo.png"/>
</p>
<p align="center">
<img src ="https://img.shields.io/badge/version-2024.4.3-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-blue.svg" />
<img src ="https://img.shields.io/github/license/vnpy/vnpy.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_evo.event import EventEngine
from vnpy_evo.trader.engine import MainEngine
from vnpy_evo.trader.ui import MainWindow, create_qapp
from vnpy_okx import (
BinanceSpotGateway,
BinanceLinearGateway,
BinanceInverseGateway
)
def main():
"""主入口函数"""
qapp = create_qapp()
event_engine = EventEngine()
main_engine = MainEngine(event_engine)
main_engine.add_gateway(BinanceSpotGateway)
main_engine.add_gateway(BinanceLinearGateway)
main_engine.add_gateway(BinanceInverseGateway)
main_window = MainWindow(main_engine, event_engine)
main_window.showMaximized()
qapp.exec()
if __name__ == "__main__":
main()
```
Raw data
{
"_id": null,
"home_page": "https://www.github.com/veighna-global",
"name": "vnpy-okx",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "quant, quantitative, investment, trading, algotrading, okx, btc, crypto",
"author": "VeighNa Global",
"author_email": "veighna@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/7a/3e/387851e0bbd2eeaddf8964f3b19340e933ce114f5cdbdb1c4e0149808637/vnpy_okx-2024.4.3.tar.gz",
"platform": null,
"description": "# OKX trading gateway for VeighNa Evo\r\n\r\n<p align=\"center\">\r\n <img src =\"https://vnpy.oss-cn-shanghai.aliyuncs.com/vnpy-logo.png\"/>\r\n</p>\r\n\r\n<p align=\"center\">\r\n <img src =\"https://img.shields.io/badge/version-2024.4.3-blueviolet.svg\"/>\r\n <img src =\"https://img.shields.io/badge/platform-windows|linux|macos-yellow.svg\"/>\r\n <img src =\"https://img.shields.io/badge/python-3.10|3.11|3.12-blue.svg\" />\r\n <img src =\"https://img.shields.io/github/license/vnpy/vnpy.svg?color=orange\"/>\r\n</p>\r\n\r\n## Introduction\r\n\r\nThis gateway is developed based on OKX's V5 REST and Websocket API, and supports spot, linear contract and inverse contract trading.\r\n\r\n**For derivatives contract trading, please notice:**\r\n\r\n1. Only supports one-way position mode.\r\n\r\n## Install\r\n\r\nUsers can easily install ``vnpy_okx`` by pip according to the following command.\r\n\r\n```\r\npip install vnpy_okx\r\n```\r\n\r\nAlso, users can install ``vnpy_okx`` using the source code. Clone the repository and install as follows:\r\n\r\n```\r\ngit clone https://github.com/veighna-global/vnpy_okx.git && cd vnpy_okx\r\n\r\npython setup.py install\r\n```\r\n\r\n## A Simple Example\r\n\r\nSave this as run.py.\r\n\r\n```\r\nfrom vnpy_evo.event import EventEngine\r\nfrom vnpy_evo.trader.engine import MainEngine\r\nfrom vnpy_evo.trader.ui import MainWindow, create_qapp\r\n\r\nfrom vnpy_okx import (\r\n BinanceSpotGateway,\r\n BinanceLinearGateway,\r\n BinanceInverseGateway\r\n)\r\n\r\n\r\ndef main():\r\n \"\"\"\u4e3b\u5165\u53e3\u51fd\u6570\"\"\"\r\n qapp = create_qapp()\r\n\r\n event_engine = EventEngine()\r\n main_engine = MainEngine(event_engine)\r\n main_engine.add_gateway(BinanceSpotGateway)\r\n main_engine.add_gateway(BinanceLinearGateway)\r\n main_engine.add_gateway(BinanceInverseGateway)\r\n\r\n main_window = MainWindow(main_engine, event_engine)\r\n main_window.showMaximized()\r\n\r\n qapp.exec()\r\n\r\n\r\nif __name__ == \"__main__\":\r\n main()\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "OKX trading gateway for VeighNa Evo.",
"version": "2024.4.3",
"project_urls": {
"Homepage": "https://www.github.com/veighna-global"
},
"split_keywords": [
"quant",
" quantitative",
" investment",
" trading",
" algotrading",
" okx",
" btc",
" crypto"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "99a8fd6bcbd3c91fb517b40904e2108cb78441239a900fdcb759044b2998f25b",
"md5": "05360c7eb9a03cf07dbf7debb101dbf0",
"sha256": "d220fc1eceb63a02fab34c70c16a3ab7b3d0c874131a23f84d3e3551c6590585"
},
"downloads": -1,
"filename": "vnpy_okx-2024.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05360c7eb9a03cf07dbf7debb101dbf0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10803,
"upload_time": "2024-04-03T13:41:33",
"upload_time_iso_8601": "2024-04-03T13:41:33.517186Z",
"url": "https://files.pythonhosted.org/packages/99/a8/fd6bcbd3c91fb517b40904e2108cb78441239a900fdcb759044b2998f25b/vnpy_okx-2024.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a3e387851e0bbd2eeaddf8964f3b19340e933ce114f5cdbdb1c4e0149808637",
"md5": "b2dd1adc7947b42676bf22aee10cd26b",
"sha256": "2539cb6eb0a5968e89502f4bc50f209424f29ac4061998202b6664c93052879e"
},
"downloads": -1,
"filename": "vnpy_okx-2024.4.3.tar.gz",
"has_sig": false,
"md5_digest": "b2dd1adc7947b42676bf22aee10cd26b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11137,
"upload_time": "2024-04-03T13:41:35",
"upload_time_iso_8601": "2024-04-03T13:41:35.609262Z",
"url": "https://files.pythonhosted.org/packages/7a/3e/387851e0bbd2eeaddf8964f3b19340e933ce114f5cdbdb1c4e0149808637/vnpy_okx-2024.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 13:41:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "vnpy-okx"
}
JSON