No project description provided
Project description
[TOC]
如何使用?
python版本:3.6 - 3.8
WebSocketAPI:建议websockets库版本为6.0
第一步:下载SDK,安装相关所需库
1.1 下载python SDK
- 将SDK目录
Clone
或者Download
到本地,选择使用okx-python-sdk-api-v5
即可
1.2 安装所需库
poetry install
第二步:配置个人信息
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尚不了解,建议参考
OKx
官方API文档 -
使用RestAPI的用户可以通过设置
example.py
文件下的flag参数来选择接入实盘或者模拟盘 -
使用WebSocketAPI的用户可以通过解开
websocket_example.py
文件下对应的url注释来选择接入实盘或者模拟盘 -
RestAPI 提供了http2的请求方式,可参考http2_example.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.6 - 3.8
WebSocketAPI: websockets package advise version 6.0
Step 1: Download the SDK and install the necessary libraries
1.1 Download python SDK
Clone
orDownload
the SDK directory to your local directory,choose to useokx-python-sdk-api-v5
1.2 Install the necessary libraries
pip install requests
pip install websockets==6.0
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
- Run
- WebSocketAPI
- Run
websocket_example.py
- According to the
public channel
/private channel
/trade
, select the correspondingurl
, the corresponding start method, and pass in the corresponding parameters
- Run
# WebSocket public channel
url = "wss://ws.okx.com:8443/ws/v5/public?brokerId=9999"
# WebSocket private channel
url = "wss://ws.okx.com:8443/ws/v5/private?brokerId=9999"
# Not necessary for public channel to login (Instrument, Tickers, Index, Mark price, Order Book, Funding rate, etc)
loop.run_until_complete(subscribe_without_login(url, channels))
# necessary for private channel to login(Account,Positions, Order, etc)
loop.run_until_complete(subscribe(url, api_key, passphrase, seceret_key, channels))
# trade(Place Order, Cancel Order, Amend Order, etc)
loop.run_until_complete(trade(url, api_key, passphrase, seceret_key, trade_param))
P.S.
-
If you know little about API, advise consulting the offical API document
-
User with RestAPI can configure parameter
flag
inexample.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
-
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file okx_integrator-0.1.1.tar.gz
.
File metadata
- Download URL: okx_integrator-0.1.1.tar.gz
- Upload date:
- Size: 44.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.19.0-38-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b21444ab2df031446811ae78907776e807dc11e12c00fd330da27906dabcc1d8 |
|
MD5 | 84e54a4c930887fb53c91cc7ea2d1dd1 |
|
BLAKE2b-256 | 2ce4a73c771467df3e3a5a925b698e524bf2cc040506b8d359ed03ab6cda56c7 |
File details
Details for the file okx_integrator-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: okx_integrator-0.1.1-py3-none-any.whl
- Upload date:
- Size: 59.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.19.0-38-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 587fdbb8eb0d86ded3ffc284046096696e3f87aa1466c9e3f7a1236f3d38d3e1 |
|
MD5 | cbe59f076bfbb3a834484f6f274eee24 |
|
BLAKE2b-256 | cb81726ed03063ab235a3dfde714983ac0ca9031f3b7d1c62aacbdf852c46289 |