Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 1.67 KB

README.md

File metadata and controls

55 lines (44 loc) · 1.67 KB
Raw

okex-py

欧易OKEx (现OKX) 数字货币自动交易python语言SDK (非官方)
OKEx (OKX) Cryptocurrency Exchange python SDK (Unofficial)

本项目基于V5 API，支持WebSocket接口
This project supports V5 REST and WebSocket API.

本项目期望使用充分的类型标注提升API的编程体验，但也因此需要高版本的python We expect to enhance the API programming experience with adequate type annotations.

API Documents: okx-zh-v5, okx-en-v5

前置条件 Requirements

Python >= 3.10

使用例子 Example

import okex.v5.account_api as account
import okex.v5.market_api as market
accountAPI = account.AccountAPI(api_key, secret_key, passphrase, False, test=test)
result = accountAPI.get_positions()
# print my positions
print(result)

文档 Documentation

施工中 Future Work

安装 Installation

方法一 (Method 1)：

  1. 直接安装，Install the package directly
pip install git+https://github.com/quantmew/okex-py.git

方法二 (Method 2)：

  1. 克隆本仓库，Clone the repository
git clone https://github.com/quantmew/okex-py.git
  1. 安装，Install the package
cd okex-py
pip install .

免责声明 Disclaimers

API接口尚不稳定
API is not yet stable
本项目不对软件运行的行为做任何保证，对于因使用本软件产生的损失均不承担任何责任。请充分测试软件后再酌情使用。
This project does not guarantee the behavior of the software and is not responsible for any damages arising from the use of the software. Please test the software sufficiently before using it.