npm 包 bithumbapi 使用教程

简介

bithumbapi 是一个基于 Node.js 平台的 npm 包，提供了对于韩国加密货币交易所 bithumb 的 API 接口请求的封装。用户可以通过该 npm 包实现对于 bithumb 的各种查询、下单、撤单等功能。

安装

npm install bithumbapi

功能与用法

初始化

const Bithumb = require('bithumbapi');
const bithumb = Bithumb({
  apiKey: 'YOUR_API_KEY',
  secretKey: 'YOUR_SECRET_KEY',
});

需要首先引入 bithumbapi ，并使用 Bithumb 创建一个新的实例。其中 apiKey 和 secretKey 分别为用户在 bithumb 官网创建的 API key 和 secret key。

请求与返回

所有 API 请求均为异步方法，需要使用 Promise 进行处理。调用成功时返回的是一个对象，对象数据结构与各 API 的响应体数据结构一致。

下面是一个 ticker 方法的示例：

bithumb.ticker('BTC').then(data => console.log(data));

API 列表

ticker

查询某个币种的最新成交价等信息。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
bithumb.ticker(currency);

orderBooks

查询某个币种的买卖挂单信息。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
bithumb.orderBooks(currency);

bids

查询某个币种的卖出挂单信息。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
bids(currency);

asks

查询某个币种的买入挂单信息。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
asks(currency);

recentTransactions

查询某个币种的最近成交记录。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
recentTransactions(currency);

balance

查询用户在 bithumb 上的账户余额信息。

balance();

placeOrder

在 bithumb 上下单。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
// string: type - 订单类型（buy, sell）
// number: price - 订单价格
// string: units - 订单数量
placeOrder(currency, type, price, units);

marketOrder

在 bithumb 上下市价单。

// 参数：
// string: currency - 币种名称（BTC, ETH, LTC, XRP, BCH, EOS, BTG, TRX, ETC, Qtum, XMR, ZEC, OMG）
// string: type - 订单类型（buy, sell）
// number: units - 订单数量
marketOrder(currency, type, units);

cancelOrder

在 bithumb 上撤销订单。

// 参数：
// string: orderId - 要撤销的订单编号
cancelOrder(orderId);

orderDetail

查询某个订单的具体信息。

// 参数：
// string: orderId - 订单编号
orderDetail(orderId);

总结

通过 bithumbapi，我们可以轻松地实现对于 bithumb 的 API 接口请求以及交易相关功能。这个 npm 包可以为用户提供很大的便利，让用户更加聚焦于业务逻辑的处理上。

希望这篇文章能够对于初学者有所帮助，帮助大家快速上手 bithumbapi 的使用。

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