/kfx-broker-okx

OKX crypto

Primary LanguageC

简介

  • 本插件为数字交易货币欧易（okx）的交易插件，可搭载在“功夫量化”软件上使用并进行量化交易。

  • 实盘交易、模拟交易均支持。

  • 若需要在源码基础上自行开发，请开发后参考下文“编译”部分重新编译，并重新安装到功夫插件目录下使用。

安装

  1. 下载客户端与插件：需要下载好 功夫客户端 （稳定版最新版即可，建议使用 .zip 压缩包 ，方便找到路径）以及本链接中的 okx 插件包，okx 插件包请在本页面右侧“Release”下载最新版插件。

  2. 找到安装目录： （1）安装的是.exe 版本：运行功夫客户端，进入后点击左上角菜单栏“文件-打开功夫安装目录” （2）安装的是.zip 版本：直接找到解压后的 kungfu 文件夹，进入“resources”

  3. 安装插件：复制 okx 插件包，即文件夹“okx”，进入{功夫安装目录} --> app --> kungfu-extensions 。粘贴 okx 文件夹到本路径

  4. 粘贴 okx 文件夹后，请重启客户端

使用

创建 API

在软件中进行量化交易，必须通过 API 访问，需要先在欧易（okx） 申请欧易 API

  1. 点击“创建 API”

  2. 选择要交易的账户，用途选择“API 交易”，权限请添加“交易”

  3. 自定义密码（passphrase），用于查看已申请的 API、登录验证。请务必牢记。

  4. 点击左侧按钮“提交全部”，申请完成

  5. 申请完毕后，需要点击“查看”，获取已申请的 API 及密钥

  6. 提供了示例策略 1 个，如有需要查看 readme 末尾

登录

交易前需要登录“行情源”及“交易账户”

  1. 打开功夫客户端
  2. 登录行情源：找到右上角“交易账户”面板，点击“添加”，选择“okx-数字货币”。
  3. 登录交易账户：找到左上角“交易账户”面板，点击“添加”，选择“okx-数字货币”

  • 账户：备注，随意填写即可。

  • 密码：填写申请 API 时的密码（passphrase）

  • api_key ：填写“查看”获得的“API”

  • 密钥：填写“查看”获得的“密钥”

  • 是否同步外部订单：若需要，请打开。（打开之后，在其他软件委托的订单都能同步显示）

  • 模拟交易：若需要进行模拟交易、测试，请打开

  1. 点击“行情源”、“交易账户” 进程的“打开”，状态变为“就绪”时，即可进行交易。

登录行情及账号可参考功夫登录教程（https://docs.kungfu-trader.com/latest/04-guide.html#id2）

功能支持

  1. 不支持币币杠杆+期权的交易、持仓查询。只支持现货、永续、合约。

  2. 交割和永续的交易模式：只支持全仓交易模式 cross，不支持倍数交易。

  3. 现货交易模式：只支持 cash。不支持倍数交易。现货交易需要指定现货交易币对.

如:交易 BTC，需要指定 BTC-USD。

  • 手动交易时，在行情订阅面板先搜索代码，添加到订阅列表才能进行交易。如搜索“BCH-BTC"

  • 策略交易时，也需要先订阅行情，如 context.subscribe(source, ["BCH-BTC"])

  1. 现货资产可通过“持仓”面板查看。 对应 okx 的 web 页面的资产 tab：

  2. 通过策略订阅行情时，柜台 Exchange 如何填写？

  • 现货（Exchange.OKX_SPOT）

  • U 本位（Exchange.OKX_USD_FUTURE）     - 币本位（Exchange.OKX_COIN_FUTURE）。

  1. 账户浮动盈亏及资金均使用服务器返回的数据，目前同步机制为 2 种     - 定时同步：60s 同步一次     - 订单变动同步：交易订单变动时实时同步一次资金、持仓数据

  2. 现货交易：现货交易以交易币对形式展示，订单成交后，持仓会同步变动。

如：买入 ETH-BTC 1 手，持仓中 ETH+1，BTC-对应数量。

Build

一. windows 环境下编译

1. 环境配置

   (1) . 打包需要安装 :

​     visual studio community 2022 版本 (安装 visual studio 会带有 cmake )

   (2) . visual studio community 2022 下载地址

注意：

编译对 vscode 版本有要求，请使用本版本，新版本 vscode 不支持

下载后，请点击“下载并更新”更新完毕后再行编译

https://visualstudio.microsoft.com/zh-hans/thank-you-downloading-visual-studio/?sku=Community&channel=Release&version=VS2022&source=VSLandingPage&cid=2030&passive=false

(3) . 编译必须使用 visual studio 自带的 64 位 shell

​     1) . 点击电脑左下角的开始菜单 开始菜单 ​     2) . 向下查找 visual studio 2022 vs2022

​     3) . 选择 x64 Native Tools Command Prompt VS 2022 x64native

二. 编译 okx 插件

1.下载 kungfu-trader 安装包

​     1) . 下载 kungfu Windows 安装包

​     2) . 安装 kungfu-trader，例如：D:\Kungfu-trader

2.下载 kfx-broker-okx 代码

​     从 github 中把代码下载到本地，例如：D:\kfx-broker-okx

3. 编译 kfx-broker-okx

​     操作如下：

​    1）启动 vs2022 命令行界面

​    2）进入 kfx-broker-okx 代码目录

​    3）输入编译命令行：D:\Kungfu-trader\resources\kfc\kfs.exe extension build

​    4）执行编译，成功编译后会在 dist 目录中生成 okx 文件夹

三. 拷贝编译成功的 okx 插件到 kungfu-trader 中

​     操作如下： ​     1）从 dist 目录中把 okx 文件拷贝到 D:\Kungfu-trader\resources\app\kungfu-extensions 文件夹中

四. 在 kungfu 客户端中添加 okx 插件

​     1) .添加交易柜台

​     2) .添加 okx 行情柜台 ​     3) .运行柜台

四. 策略 demo 用例

​     1）添加策略

OkxDemo源码在demo文件夹中。

​     2）运行策略

​     3）查看账户持仓信息

​     4）查看策略运行日志