npm 包 node-bitmax-api 使用教程

Node-bitmax-api 是一个用于 BitMax 数字货币交易所的 Node.js API 包，它可以让前端开发者在 Node.js 环境下使用 BitMax 数字货币交易所的 API。

本文将详细介绍 npm 包 node-bitmax-api 的使用教程，内容包括安装、配置、 API 介绍以及示例代码等。

安装

在使用 node-bitmax-api 之前，需要安装 Node.js 和 npm。安装完成后，在终端中输入以下命令即可安装 node-bitmax-api：

npm install node-bitmax-api

配置

在使用 node-bitmax-api 之前，需要在 BitMax 数字货币交易所的网站上注册账号，并创建 API key。API key 将用于 node-bitmax-api 的访问。

在您的项目目录中，创建一个名为 config.json 的文件，用于存储 API key。

{
  "apiKey": "yourApiKey",
  "secret": "yourSecretKey"
}

API 介绍

node-bitmax-api 提供了 BitMax 数字货币交易所的所有 API。

Balances

获取账户余额。

const bitmax = require('node-bitmax-api');

// 获取账户余额
bitmax.balances().then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

Orders

下单。可选参数：side、symbol、price、qty。

const bitmax = require('node-bitmax-api');

// 下单
bitmax.orders({ side: 'buy', symbol: 'BTC/USDT', price: '10000', qty: '1' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

OrdersByOrderId

通过订单 ID 获取订单详情。

const bitmax = require('node-bitmax-api');

// 通过订单 ID 获取订单详情
bitmax.ordersByOrderId({ orderId: '123456' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

OrdersByClientId

通过客户端编号获取订单详情。

const bitmax = require('node-bitmax-api');

// 通过客户端编号获取订单详情
bitmax.ordersByClientId({ clientId: 'client123' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

OrdersBySymbol

通过交易对获取订单列表。

const bitmax = require('node-bitmax-api');

// 通过交易对获取订单列表
bitmax.ordersBySymbol({ symbol: 'BTC/USDT' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

CancelOrderByOrderId

通过订单 ID 取消订单。

const bitmax = require('node-bitmax-api');

// 通过订单 ID 取消订单
bitmax.cancelOrderByOrderId({ orderId: '123456' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

CancelOrderByClientId

通过客户端编号取消订单。

const bitmax = require('node-bitmax-api');

// 通过客户端编号取消订单
bitmax.cancelOrderByClientId({ clientId: 'client123' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

TradesByOrderId

通过订单 ID 获取成交记录。

const bitmax = require('node-bitmax-api');

// 通过订单 ID 获取成交记录
bitmax.tradesByOrderId({ orderId: '123456' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

TradesBySymbol

通过交易对获取成交记录。

const bitmax = require('node-bitmax-api');

// 通过交易对获取成交记录
bitmax.tradesBySymbol({ symbol: 'BTC/USDT' }).then(result => {
  console.log(result);
}).catch(error => {
  console.error(error);
});

示例代码

下面是一个示例代码，用于向 BitMax 数字货币交易所的 BTC/USDT 交易对下买单。

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

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

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

总结

本文详细介绍了 npm 包 node-bitmax-api 的使用教程，包括安装、配置、 API 介绍以及示例代码等。希望本文能够对前端开发者了解和使用 node-bitmax-api 有所帮助。

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