npm 包 bitcoin-unocoin-client 使用教程

阅读时长 8 分钟读完

简介

bitcoin-unocoin-client 是一个 Node.js 模块,用于与 Unocoin Bitcoin 交易平台进行通信。可以使用该模块的 API 进行连接 Unocoin 并自动执行交易、管理钱包等。该模块允许您自动化交易,创建定期的买单和卖单,以及监控您的钱包余额等。

安装

要使用 bitcoin-unocoin-client 模块,您首先需要安装 Node.js 和 npm(包管理器)。然后可以在您的项目目录下运行以下命令安装该模块:

快速入门

以下是一个简单的示例,显示如何使用 bitcoin-unocoin-client 模块进行连接 Unocoin 并获取您的钱包余额:

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

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

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

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

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

输出:

在上面的示例中,我们首先使用 require('bitcoin-unocoin-client') 引入 bitcoin-unocoin-client 模块。然后,我们创建一个新的 UnocoinClient 实例,并调用 connect() 方法与 Unocoin 交易平台进行连接。接下来,我们使用 getBalance() 方法获取我们的钱包余额,并将其打印到控制台上。最后,我们断开与 Unocoin 的连接,调用 disconnect() 方法。

API 文档

以下是 bitcoin-unocoin-client 模块提供的 API 文档。

new UnocoinClient([options])

创建一个新的 UnocoinClient 实例。

  • options 对象(可选):包含以下属性:
    • url:Unocoin API 的基本 URL。默认为 'https://www.unocoin.com/tradeapi/v1'

client.connect()

与 Unocoin 交易平台建立连接。

client.disconnect()

断开与 Unocoin 交易平台的连接。

client.getBalance([currency])

获取当前钱包余额。

  • currency 字符串(可选):要获取余额的货币类型。默认为 'BTC'

client.getTicker([currency])

获取当前 Bitcoin 交易价格。

  • currency 字符串(可选):要获取价格的货币类型。默认为 'INR'

client.getOrders()

获取当前所有订单。

client.getOpenOrders([options])

获取当前所有未完成的订单。

  • options 对象(可选):包含以下属性:
    • pair:要获取订单的货币对。默认为 'btc_inr'

client.createOrder(type, price, amount)

创建一个新的订单。

  • type 字符串:订单类型。必须是 'buy''sell'
  • price 数字:订单价格。
  • amount 数字:订单数量。

client.cancelOrder(id)

取消一个未完成的订单。

  • id 字符串:要取消订单的 ID。

client.getWalletAddresses()

获取当前钱包的可用地址。

client.createNewWalletAddress()

创建一个新的钱包地址。

示例

以下是一个使用 bitcoin-unocoin-client 模块的高级示例,实现了一个简单的自动交易机器人。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

在上面的示例中,我们使用 setInterval() 函数设置了一个定时器,每隔 1 分钟检查一次交易情况。在每次间隔中,我们获取当前余额、当前交易价格以及未完成的订单列表。然后,我们检查是否需要创建新的买单或卖单,或者取消过期的未完成订单。创建新订单时,我们使用 createOrder() 方法;取消未完成的订单时,我们使用 cancelOrder() 方法。

结论

通过本文,您学会了如何使用 bitcoin-unocoin-client 模块实现自动化 Bitcoin 交易。该模块提供了一组简单易用的 API,可用于连接 Unocoin 交易平台,自动执行交易、管理钱包等功能。使用示例代码和文档,您现在可以开始使用该模块,创建您自己的自动交易机器人了!

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

纠错
反馈