npm 包 btc-markets-ws-api 使用教程

阅读时长 4 分钟读完

在比特币市场交易中,常常需要使用到市场行情数据以及交易深度数据。而 btc-markets-ws-api 就是一个专门针对 BTC Markets 市场的 WebSocket API,可用于获取实时的市场行情数据和交易深度数据,并进行市场交易。本篇文章将介绍 btc-markets-ws-api 的使用方法,并提供相应的代码示例。

安装

在使用 btc-markets-ws-api 之前,需要先在本地环境中进行安装。在命令行中,输入以下命令:

配置

在进行 btc-markets-ws-api 的使用之前,需要进行一些基本配置。在代码中,使用以下方式进行配置:

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

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

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

其中,各配置参数的含义如下:

  • websocketUrl:WebSocket API 的地址。
  • apiKey:API Key。
  • apiSecret:API Secret。
  • currency:货币类型,可选参数为 “AUD” 和 “USD”。
  • instrument:交易对,目前仅支持 “BTC”。
  • debug:是否开启调试模式。

需要注意的是,在使用 btc-markets-ws-api 进行市场交易时,需要提供 API Key 和 API Secret,因此在进行实际交易之前需要进行相应的申请及配置。

订阅市场行情数据

在 btc-markets-ws-api 中,可以订阅市场行情数据。代码示例如下:

其中,subscribeTicker 方法用于订阅市场行情数据,回调函数中将返回实时的市场行情数据。需要注意的是,其中的 ticker 对象包含以下属性:

  • bestBid:最高买入价。
  • bestAsk:最低卖出价。
  • lastPrice:最近一笔成交价。
  • currency:货币类型。
  • instrument:交易对。

订阅交易深度数据

在进行市场交易时,需要了解市场上的买单和卖单数量,以便进行合理的交易决策。在 btc-markets-ws-api 中,可以订阅交易深度数据。代码示例如下:

其中,subscribeDepth 方法用于订阅交易深度数据,回调函数中将返回实时的交易深度数据。需要注意的是,其中的 depth 对象包含以下属性:

  • bids:买单信息,数组类型,每个元素包含以下属性:
    • price:挂单价格。
    • volume:挂单数量。
  • asks:卖单信息,数组类型,每个元素包含以下属性:
    • price:挂单价格。
    • volume:挂单数量。
  • currency:货币类型。
  • instrument:交易对。

市场交易

在 btc-markets-ws-api 中,支持市场下单和市场撤单的操作。代码示例如下:

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

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

其中,marketBuy 方法用于进行市价买入,参数 100 表示买入数量为 100,回调函数中将返回市场下单的结果;cancelOrders 方法用于撤销当前挂单,[] 表示撤销所有挂单,回调函数中将返回撤单结果。

需要注意的是,在进行市场交易操作前,需要先配置 API Key 和 API Secret。

总结

通过本篇文章的介绍,我们了解了 btc-markets-ws-api 的基本使用方法,并对市场行情数据、交易深度数据以及市场交易进行了详细的探讨。通过对 btc-markets-ws-api 的使用,我们可以更加方便地获取市场数据以及进行市场交易操作,从而更加迅速、高效地进行比特币市场交易。

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

纠错
反馈