npm 包 kraken-wrapper 使用教程

简介

kraken-wrapper 是针对 Kraken 数字货币交易所 API 的封装工具库，提供了一系列简单易用的 API 方法供开发者使用，并且支持了多种常见的币种交易。

Kraken 是业内领先的数字货币交易所之一，其 API 可以让开发者通过编程调用 Kraken 的交易功能，进而实现自动化交易。

安装

在使用之前，我们需要在项目根目录下通过 npm install 命令安装 kraken-wrapper。

npm install kraken-wrapper

安装完成之后，我们需要在代码中导入 kraken-wrapper 模块：

const Kraken = require('kraken-wrapper');

API 方法

kraken-wrapper 将 Kraken 提供的原生 API 进行了封装，提供了更为友好的 API 方法。下面，我们介绍一下 kraken-wrapper 支持的 API 方法。

1. getTicker(pair, callback)

方法说明： 获取指定交易对的最新市场数据

参数说明：

• pair：交易对，必填参数，类型为字符串。
• callback：回调函数，必填参数，类型为函数。回调函数的参数为请求到的数据。

示例代码：

Kraken.getTicker('XXBTZUSD', (data) => {
  console.log('最新市场数据：', data);
});

2. getOHLCData(params, callback)

方法说明： 获取指定交易对的 OHLC 数据

参数说明：

• params：查询参数，必填参数，类型为对象。对象的属性包括：

  • pair：交易对，必填参数，类型为字符串。
  • interval：时间间隔，必填参数，类型为字符串。可选值为 '1'（1 分钟）、'5'（5 分钟）、'15'（15 分钟）、'30'（30 分钟）、'60'（1 小时）、'240'（4 小时）、'1440'（1 天）、'10080'（1 周）、'21600'（15 天）。
  • since：起始时间戳，可选参数，类型为数字。
  • pairData：是否需要交易对信息，可选参数，类型为布尔值。

• callback：回调函数，必填参数，类型为函数。回调函数的参数为请求到的数据。

示例代码：

Kraken.getOHLCData({
  pair: 'XXBTZUSD',
  interval: '60',
  since: 1592794209,
  pairData: false
}, (data) => {
  console.log('OHLC 数据：', data);
});

3. getOrderBook(params, callback)

方法说明： 获取指定交易对的委托买入和委托卖出数据

参数说明：

• params：查询参数，必填参数，类型为对象。对象的属性包括：

  • pair：交易对，必填参数，类型为字符串。
  • count：显示条目数，可选参数，类型为数字。默认值为 100，最大值为 500。
  • depth：显示深度，可选参数，类型为数字。

• callback：回调函数，必填参数，类型为函数。回调函数的参数为请求到的数据。

示例代码：

Kraken.getOrderBook({
  pair: 'XXBTZUSD',
  count: 10,
  depth: 5
}, (data) => {
  console.log('委托数据：', data);
});

4. getRecentTrades(params, callback)

方法说明： 获取指定交易对的最近成交数据

参数说明：

• params：查询参数，必填参数，类型为对象。对象的属性包括：

  • pair：交易对，必填参数，类型为字符串。
  • since：起始时间戳，可选参数，类型为数字。

• callback：回调函数，必填参数，类型为函数。回调函数的参数为请求到的数据。

示例代码：

Kraken.getRecentTrades({
  pair: 'XXBTZUSD',
  since: 1592794209
}, (data) => {
  console.log('最近成交数据：', data);
});

5. addOrder(params, callback)

方法说明： 创建订单

参数说明：

• params：查询参数，必填参数，类型为对象。对象的属性包括：

  • pair：交易对，必填参数，类型为字符串。
  • type：订单类型，必填参数，类型为字符串。可选值为 'buy' 或 'sell'。
  • volume：交易数量，必填参数，类型为数字。
  • price：交易价格，必填参数，类型为数字。
  • leverage：杠杆倍数，可选参数，类型为数字。
  • price2：触发价格，可选参数，类型为数字。
  • order：附加信息，可选参数，类型为字符串。长度不能超过 4096 个字符。

• callback：回调函数，必填参数，类型为函数。回调函数的参数为请求到的数据。

示例代码：

Kraken.addOrder({
  pair: 'XXBTZUSD',
  type: 'buy',
  volume: 0.5,
  price: 9500
}, (data) => {
  console.log('创建订单结果：', data);
});

结语

通过使用 kraken-wrapper 封装的 Kraken API，我们可以更加便捷高效地获取 Kraken 交易所的市场数据、进行交易等操作，从而实现自动化交易的目标。此外，kraken-wrapper 的代码非常简洁易懂，适合初学者使用。

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