npm 包 @coinbotapp/client 使用教程

阅读时长 5 分钟读完

前言

在进行前端开发的过程中,我们经常会使用到各种 npm 包来提高开发效率和增强功能。如今,越来越多的应用场景需要使用到加密货币交易,@coinbotapp/client 就是一个专门用于构建加密货币交易策略的 npm 包。本文将介绍如何使用 @coinbotapp/client,帮助读者快速上手使用此 npm 包。

安装

使用 @coinbotapp/client 包,需要先安装 npm,然后使用如下命令安装:

接下来,我们就可以在代码中引入 @coinbotapp/client 了:

功能

@coinbotapp/client 包提供了如下的功能:

  1. 基于 websocket 接口获取实时加密货币市场数据
  2. 订阅单个或多个加密货币市场的数据流
  3. 下单和撤单
  4. 查询订单状态和交易历史

使用

初始化

首先,我们需要用到 CoinBotClient 构造函数创建实例对象。

构造函数接收一个可配置的参数对象,如上所示。

  • endpoint:API 的地址。
  • apiKey:API 密钥,启用了的接口必填。
  • apiSecret:API 私钥,启用了的接口必填。

订阅市场数据

@coinbotapp/client 包提供的市场数据订阅功能,支持订阅单个或多个加密货币市场的数据流。这里我们以订阅 btcusdt 市场数据为例。

其中,subscribe 方法接收一个可配置的参数对象,如上所示:

  • topic:数据主题,不同的数据主题对应不同的数据类型,如深度数据为 market.{symbol}.depth
  • symbol:加密货币交易对,btcusdt 表示比特币对美元的交易。
  • type:数据频率,step0 表示实时深度数据。
  • handler:处理函数,当数据更新时会自动调用该函数。

下单

接下来,我们将会介绍如何使用 @coinbotapp/client 包进行订单下单和撤单操作。

其中,placeOrder 方法接收一个可配置的订单参数对象,如上所示:

  • symbol:加密货币交易对。
  • side:订单方向,buy 表示买入,sell 表示卖出。
  • amount:下单数量。
  • price:下单价格。
  • type:订单类型,limit 表示限价单。

撤单

当我们需要进行订单撤单操作时,可以使用如下代码:

其中,cancelOrder 方法接收一个可配置的参数对象,如上所示:

  • orderId:要撤销的订单 ID。
  • symbol:加密货币交易对。

订单状态和查询交易历史

使用 @coinbotapp/client 包还可以查询订单的状态和交易历史。

其中,getOrder 方法接收一个可配置的参数对象,如上所示:

  • orderId:要查询的订单 ID。
  • symbol:加密货币交易对。
  • type:订单类型。

查询交易历史的过程也很类似:

其中,getTrades 方法接收一个可配置的参数对象,如上所示:

  • symbol:加密货币交易对。

示例代码

-- -------------------- ---- -------
----- - ------------- - - ------------------------------

----- ------ - --- ---------------
  --------- --------------------------------------
  ------- ---------------
  ---------- ------------------
---

------------------
  ------ -----------------------
  ------- ----------
  ----- --------
  -------- ------ -- -
    ------------------
  --
---

-------------------
  ------- ----------
  ----- ------
  ------- --
  ------ ------
  ----- --------
---

--------------------
  -------- ---------
  ------- ----------
---

-----------------
  -------- ---------
  ------- ----------
  ----- --------
---

------------------
  ------- ----------
---

总结

从本文中,我们了解到如何使用 @coinbotapp/client 包构建加密货币交易策略。当然,上述功能仅仅是 @coinbotapp/client 包提供的一部分 API,更多使用方法可以通过阅读官方文档以及相关使用案例等方式获取,希望此文章能对读者提供一些帮助。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055aeb81e8991b448d8906

纠错
反馈