Skip to content

foolmuyi/okx-api-v5

 
 

Repository files navigation

在原项目的基础上增加了对Marketplace中NFT市场的支持,具体使用示例见mkt_example.py文件,使用前需在项目路径下创建.env文件设置API_KEYSECRET_KEYPASSPHRASEPRIVATE_KEY


如何使用?

python版本:3.6+

WebSocketAPI:建议websockets库版本为6.0

第一步:下载SDK,安装相关所需库

1.1 下载python SDK

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

1.2 安装所需库

pip install requests
pip install websockets==6.0

第二步:配置个人信息

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

2.2 将各项信息在example.py(RestAPI)websocket_example.py(WebSocketAPI)中填写

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

第三步:调用接口

  • RestAPI

    • 运行example.py

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

  • WebSocketAPI

    • 运行websocket_example.py

    • 根据公共频道/私有频道/交易选择对应url、对应启动方法,传入相应参数即可

    # WebSocket公共频道
    url = "wss://ws.okx.com:8443/ws/v5/public?brokerId=9999"
    
    # WebSocket私有频道
    url = "wss://ws.okx.com:8443/ws/v5/private?brokerId=9999"
    # 公共频道 不需要登录(行情,持仓总量,K线,标记价格,深度,资金费率等)
    loop.run_until_complete(subscribe_without_login(url, channels))
    
    # 私有频道 需要登录(账户,持仓,订单等)
    loop.run_until_complete(subscribe(url, api_key, passphrase, seceret_key, channels))
    
    # 交易(下单,撤单,改单等)
    loop.run_until_complete(trade(url, api_key, passphrase, seceret_key, trade_param))

附言:

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

  • 使用RestAPI的用户可以通过设置example.py文件下的flag参数来选择接入实盘或者模拟盘

  • 使用WebSocketAPI的用户可以通过解开websocket_example.py文件下对应的url注释来选择接入实盘或者模拟盘

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

    • asynciowebsockets文档/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
      

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%