python-okx/README.md

[TOC]

如何使用？

`python版本：>=3.9

WebSocketAPI：autobahn.twisted>=22.10.0

第一步：下载SDK，安装相关所需库

1.1 下载python SDK

• 将SDK目录Clone或者Download到本地，选择使用okx-python-sdk-api-v5即可

1.2 安装所需库

pip install requests
pip install autobahn\[twisted\]
pip install pyOpenSSL

第二步：配置个人信息

2.1 如果还未有API，可点击前往官网进行申请

api_key = ""
secret_key = ""
passphrase = ""

第三步：调用接口

• RestAPI

  • 运行example.py

  • 解开相应方法的注释传参调用各接口即可

• WebSocketAPI

  • 参考Test文件夹下WsPrivate和WsPublic文件示例；
  • 根据公共频道/私有频道选择对应url(如果是私有频道需要设置登陆信息)，传入相应参数即可。

  # WebSocket公共频道
  url = "wss://ws.okx.com:8443/ws/v5/public"
  # WebSocket私有频道
  url = "wss://ws.okx.com:8443/ws/v5/private"
  

  # 公共频道 不需要登录（行情，持仓总量，K线，标记价格，深度，资金费率等）
  参考 WsPublicTest.py
  
  # 私有频道 需要登录（账户，持仓，订单等）
  参考 WsPrivateTest.py
  

附言：

• 如果对API尚不了解，建议参考OKX官方API文档

• 使用RestAPI的用户可以通过参考Test文件夹下的示例，设置正确的参数即可

• 使用WebSocketAPI的用户可以通过参考Test文件夹下的WsPublicTest.py和WsPrivateTest.py，设置正确的参数即可

• 若使用WebSocketAPI遇到问题建议参考相关链接

  • asyncio、websockets文档/github： https://docs.python.org/3/library/asyncio-dev.html https://websockets.readthedocs.io/en/stable/intro.html https://github.com/aaugustin/websockets

  • 关于code=1006： https://github.com/Rapptz/discord.py/issues/1996 https://github.com/aaugustin/websockets/issues/587

How to use ?

python version：>=3.9

WebSocketAPI： autobahn.twisted>=22.10.0

Step 1: Download the SDK and install the necessary libraries

1.1 Download python SDK

• Clone or Download the SDK directory to your local directory,choose to use okx-python-sdk-api-v5

1.2 Install the necessary libraries

pip install requests
pip install autobahn\[twisted\]
pip install pyOpenSSL

Step 2: Configure Personal Information

2.1 If you have no API，Click here to the official websit to apply for the API

2.2 Fill out all necessary informatiuon in example.py（RestAPI） and websocket_example.py（WebSocketAPI）

api_key = ""
secret_key = ""
passphrase = ""

Step 3: Call API

• RestAPI
  • Run example.py
  • Uncomment the corresponding method and then pass the arguments and call the interfaces
• WebSocketAPI

• Open WsPrivateandWsPublic；
• choose the right url(if private channel need login info).

# WebSocket Public channel
url = "wss://ws.okx.com:8443/ws/v5/public"
# WebSocket Private channel
url = "wss://ws.okx.com:8443/ws/v5/private"

# Public channel not need login(e.g. tickers,candle,mark-price,books,funding-rate)
refer to WsPublicTest.py

# Private channel nedd login(e.g. account,positions,orders)
refer to  WsPrivateTest.py

P.S.

• If you know little about API, advise consulting the offical API document

• User with RestAPI can configure parameter flag in example.py in to choose to access to real trading or demo trading

• User with WebSocketAPI can ucomment the corresponding url to choose to access to real trading or demo trading

• Rest API support request by http2, you can refer to http2_example

• If you face any questions when using WebSocketAPI,you can consult related link

  • asyncio、websockets document/github：

    https://docs.python.org/3/library/asyncio-dev.html
    https://websockets.readthedocs.io/en/stable/intro.html
    https://github.com/aaugustin/websockets
    

  • About code=1006：

    https://github.com/Rapptz/discord.py/issues/1996
    https://github.com/aaugustin/websockets/issues/587