npm 包 bitfinexapi-tinycalf 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

bitfinexapi-tinycalf 是一款 Node.js 版本的 npm 包，旨在为使用 Bitfinex API 的前端开发者提供简单且易于理解的操作界面。该包封装了 Bitfinex 提供的 REST API，并可与 WebSocket API 配合使用。由于其简单易用的特点，得到了广泛的应用。

安装

使用 bitfinexapi-tinycalf 前，需要在项目中安装该包：

npm install bitfinexapi-tinycalf

使用

初始化

在使用 bitfinexapi-tinycalf 之前，需要先初始化：

 const bitfinex = require('bitfinexapi-tinycalf');
 const options = {
     apiKey: 'xxx',
     apiSecret: 'xxx',
 };
 const rest = bitfinex.rest(options);  // 初始化 REST 服务
 const ws = bitfinex.ws(options);  // 初始化 WebSocket 服务

其中，apiKey 和 apiSecret 是 Bitfinex API 提供的认证信息，必须进行填写。初始化成功后，可以调用相关的 REST 和 WebSocket API 接口。

REST API

bitfinexapi-tinycalf 封装了 Bitfinex API 的各种 REST 接口，用于方便用户查询和操作相关数据。以下是一些基础的 REST API 的使用方法：

获取当前价格

 rest.ticker('btcusd')
     .then(data => {
         console.log(data);
     })
     .catch(err => {
         console.log(err);
     });

获取买单和卖单价格

 rest.orderbooks('btcusd')
     .then(data => {
         console.log(data);
     })
     .catch(err => {
         console.log(err);
     });

获取 K 线数据

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

更多接口详见 https://docs.bitfinex.com/reference。

WebSocket API

bitfinexapi-tinycalf 提供了基于 WebSocket 的实时数据查询功能。以下是一些基础使用方法：

获取最新成交信息

 ws.on('open', () => {
     ws.subscribe('trades', 'btcusd');
 });
 ws.on('message', message => {
     console.log(message);
 });

获取市场深度信息

 ws.on('open', () => {
     ws.subscribe('book', 'btcusd');
 });
 ws.on('message', message => {
     console.log(message);
 });

更多接口详见 https://docs.bitfinex.com/v2/docs/ws-general。

示例代码

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

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

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

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

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

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

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

总结

bitfinexapi-tinycalf 是一个方便易用的 Bitfinex API 封装 npm 包，为前端开发者提供了丰富的数据查询和操作接口。借助该包，开发者不需掌握 API 的细节，即可高效地查询和操作数据。同时，该包也提供了 WebSocket 实时数据查询功能，使开发者能获得最新的市场信息。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005612781e8991b448df383